wt.federation
Class ProxyDocument

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.RevisionControlled
          wt.doc.WTDocument
              wt.federation.ProxyDocument

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, IdentityAccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, Changeable2, ChangeableIfc, ContentHolder, FormatContentHolder, Document, DocumentVersion, wt.enterprise.Templateable, Releasable, wt.fc.archive.Archiveable, wt.fc.archive.ArchiveablePrimary, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, Federated, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, IteratedFoldered, wt.iba.value.IBAHolder, DisplayIdentification, Indexable, WTContained, wt.inf.container.WTContainedFilterable, IteratedLifeCycleManaged, wt.lifecycle.LifeCycleManaged, Lockable, wt.maturity.Promotable, wt.meeting.actionitem.IteratedSubjectOfActionItem, wt.meeting.actionitem.SubjectOfActionItem, Notifiable, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedVersion, Ownable, wt.recent.RecentlyVisited, wt.representation.Representable, wt.representation.RepresentablesAndMasters, wt.representation.RepresentationContributor, wt.team.TeamManaged, wt.type.FlexTyped, wt.type.Typed, wt.ufid.Federatable, wt.util.depthLock._DepthLock000, wt.util.depthLock._DepthLock001, wt.util.depthLock._DepthLock002, wt.util.depthLock._DepthLock003, wt.util.depthLock._DepthLock004, wt.util.depthLock._DepthLock005, wt.util.depthLock._DepthLock006, wt.util.depthLock._DepthLock007, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned, Workable, wt.viewmarkup.Viewable, wt.workflow.forum.IteratedSubjectOfForum, wt.workflow.forum.SubjectOfForum, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook, wt.workflow.requirement.RequirementsManageable

public class ProxyDocument
extends WTDocument
implements Federated, Externalizable

Use the newProxyDocument static factory method(s), not the ProxyDocument constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

Fields inherited from class wt.doc.WTDocument

DEPARTMENT, DESCRIPTION, DOC_TYPE, NAME, NUMBER, TITLE

Fields inherited from class wt.enterprise.RevisionControlled

MASTER

Fields inherited from interface wt.federation.Federated

SERVICE_ID

Fields inherited from interface wt.org.OrganizationOwnedVersion

MASTER, MASTER_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Method Summary

QueryResult	findLinks(Class targetLinkClass, String obj1Role, Persistable obj2) Return all link objects that exist between the Federated object and the specified source object.
Mastered	getMaster() Gets the object for the association that plays the role: MASTERED Supported API: true
FederatedService	getService() Return the service object referenced by the serviceId attribute.
ServiceIdentifier	getServiceId() Gets the object for the association that plays role: SERVICE_ID.
String	getSourceName() Gets the value of the attribute: SOURCE_NAME Supported API: true
String	getSourceNumber() Gets the value of the attribute: SOURCE_NUMBER Supported API: true
QueryResult	navigate(String role, Class linkClass, boolean onlyOtherSide) Return objects related to this federated source object given a role and link class.
QueryResult	navigate(String role, QuerySpec criteria, boolean onlyOtherSide) Return objects related to this federated source object given a role and link selection crtieria.
void	postStore() The persistence manager calls this method just after storing the proxy object in the database.
void	prepareForStore() The persistence manager calls this method just before storing the proxy object in the database.
void	preset() This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source.
void	refresh() Refresh the derived attributes of the object.
void	refreshIfStale() Refresh the derived attributes of the object, but only if the properties are stale.
void	setServiceId(ServiceIdentifier a_ServiceId) Sets the object for the association that plays role: SERVICE_ID.
void	setSourceName(String name) Sets the value of the attribute: SOURCE_NAME Supported API: true
void	setSourceNumber(String number) Sets the value of the attribute: SOURCE_NUMBER Supported API: true
void	update() Update the derived attributes of the object on the source service.

Methods inherited from class wt.doc.WTDocument

getDepartment, getDescription, getDocType, getName, getNumber, getOrganization, getOrganizationCodingSystem, getOrganizationName, getOrganizationUniqueIdentifier, getTitle, newWTDocument, newWTDocument, newWTDocument, setDepartment, setDescription, setDocType, setName, setNumber, setOrganization, setTitle

Methods inherited from class wt.enterprise.RevisionControlled

getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setMaster, setMasterReference

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.org.OrganizationOwnedVersion

getMasterReference

Method Detail

getSourceName

public String getSourceName()

Gets the value of the attribute: SOURCE_NAME

Supported API: true

Returns:

String

setSourceName

public void setSourceName(String name)
                   throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_NAME

Supported API: true

Parameters:

name -

Throws:

WTPropertyVetoException

getSourceNumber

public String getSourceNumber()

Gets the value of the attribute: SOURCE_NUMBER

Supported API: true

Returns:

String

setSourceNumber

public void setSourceNumber(String number)
                     throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_NUMBER

Supported API: true

Parameters:

number -

Throws:

WTPropertyVetoException

getMaster

public Mastered getMaster()

Gets the object for the association that plays the role: MASTERED

Supported API: true

Specified by:

getMaster in interface OrganizationOwnedVersion

Specified by:

getMaster in interface Iterated

Overrides:

getMaster in class RevisionControlled

Returns:

Mastered

See Also:

Mastered

getService

public FederatedService getService()
                            throws wt.federation.FederationServicesException

Return the service object referenced by the serviceId attribute.

Supported API: true

Specified by:

getService in interface Federated

Returns:

FederatedService

Throws:

wt.federation.FederationServicesException

preset

public void preset()
            throws wt.federation.FederationServicesException

This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source. This method allows the proxy object to do further class-specific initialization.

Supported API: true

Specified by:

preset in interface Federated

Throws:

wt.federation.FederationServicesException

refresh

public void refresh()
             throws wt.federation.FederationServicesException

Refresh the derived attributes of the object.

Supported API: true

Specified by:

refresh in interface Federated

Throws:

wt.federation.FederationServicesException

refreshIfStale

public void refreshIfStale()
                    throws wt.federation.FederationServicesException

Refresh the derived attributes of the object, but only if the properties are stale.

Supported API: true

Specified by:

refreshIfStale in interface Federated

Throws:

wt.federation.FederationServicesException

update

public void update()
            throws wt.federation.FederationServicesException

Update the derived attributes of the object on the source service.

Supported API: true

Specified by:

update in interface Federated

Throws:

wt.federation.FederationServicesException

prepareForStore

public void prepareForStore()
                     throws wt.federation.FederationServicesException

The persistence manager calls this method just before storing the proxy object in the database. This gives the object an opportunity to make associated proxy objects persistent, if necessary.

Supported API: true

Specified by:

prepareForStore in interface Federated

Throws:

wt.federation.FederationServicesException

findLinks

public QueryResult findLinks(Class targetLinkClass,
                             String obj1Role,
                             Persistable obj2)
                      throws wt.federation.FederationServicesException

Return all link objects that exist between the Federated object and the specified source object.

Supported API: true

Specified by:

findLinks in interface Federated

Parameters:

targetLinkClass -

obj1Role -

obj2 -

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

navigate

public QueryResult navigate(String role,
                            Class linkClass,
                            boolean onlyOtherSide)
                     throws wt.federation.FederationServicesException

Return objects related to this federated source object given a role and link class. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Specified by:

navigate in interface Federated

Parameters:

role -

linkClass -

onlyOtherSide -

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

navigate

public QueryResult navigate(String role,
                            QuerySpec criteria,
                            boolean onlyOtherSide)
                     throws wt.federation.FederationServicesException

Return objects related to this federated source object given a role and link selection crtieria. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Specified by:

navigate in interface Federated

Parameters:

role -

criteria -

onlyOtherSide -

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

postStore

public void postStore()
               throws wt.federation.FederationServicesException

The persistence manager calls this method just after storing the proxy object in the database. This gives the object an opportunity to make associated objects persistent, if necessary. For example, links between the proxy object and other objects need to be persisted after the proxy object is persisted.

Supported API: true

Specified by:

postStore in interface Federated

Throws:

wt.federation.FederationServicesException

getServiceId

public ServiceIdentifier getServiceId()

Gets the object for the association that plays role: SERVICE_ID.

Supported API: true

Specified by:

getServiceId in interface Federated

Returns:

ServiceIdentifier

setServiceId

public void setServiceId(ServiceIdentifier a_ServiceId)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: SERVICE_ID.

Supported API: true

Specified by:

setServiceId in interface Federated

Parameters:

a_ServiceId -

Throws:

WTPropertyVetoException