wt.federation
Class ProxyDocument

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

All Implemented Interfaces:

_DepthLock000, _DepthLock001, _DepthLock002, _DepthLock003, _DepthLock004, _DepthLock005, _DepthLock006, _DepthLock007, AccessControlled, AccessControlList, AdHocControlled, Archiveable, Baselineable, BusinessInformation, CabinetBased, Changeable2, ChangeableIfc, ContentHolder, DisplayIdentification, Document, DocumentVersion, DomainAdministered, ElectronicallySignable, Externalizable, Federatable, Federated, Foldered, FolderEntry, FolderServiceManaged, FormatContentHolder, IBAHolder, Indexable, Iterated, IteratedFoldered, IteratedLifeCycleManaged, IteratedSubjectOfForum, IteratedSubjectOfNotebook, LifeCycleManaged, Lockable, NetFactor, Notifiable, ObjectMappable, OneOffVersioned, OrganizationOwned, OrganizationOwnedVersion, Ownable, Persistable, Promotable, RecentlyVisited, Releasable, RemotelyLinkable, Representable, RepresentablesAndMasters, RepresentationContributor, RequirementsManageable, Serializable, SubjectOfForum, SubjectOfNotebook, TeamManaged, Templateable, Typed, Versionable, Versioned, Viewable, Workable, WTContained

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

private static String	CLASSNAME
private long	expirationTime
static long	EXTERNALIZATION_VERSION_UID
private Mastered	master
protected static long	OLD_FORMAT_VERSION_UID
private long	refreshTime
private static String	RESOURCE
(package private) static long	serialVersionUID
private ServiceIdentifier	serviceId
static String	SOURCE_ATTRIBUTES Label for the attribute.
private Hashtable	sourceAttributes
private Vector	sourceContentList
private String	sourceObjectId
private String	sourceURL
private static boolean	VERBOSE

Fields inherited from class wt.doc.WTDocument

CONTAINER, DEPARTMENT, DESCRIPTION, DOC_TYPE, NAME, NUMBER, R51_EXTERNALIZATION_VERSION_UID, R60_EXTERNALIZATION_VERSION_UID, TITLE

Fields inherited from class wt.enterprise.RevisionControlled

MASTER, VERSION_DISPLAY_IDENTIFIER, VERSION_DISPLAY_IDENTITY, VERSION_DISPLAY_TYPE

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.federation.Federated

EXPIRATION_TIME, REFRESH_TIME, SERVICE_ID, SOURCE_OBJECT_ID, SOURCE_URL

Fields inherited from interface wt.content.FormatContentHolder

FORMAT, FORMAT_NAME, PRIMARY

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.type.Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.enterprise.Templateable

TEMPLATE, TEMPLATED

Fields inherited from interface wt.org.OrganizationOwnedVersion

MASTER, MASTER_REFERENCE, ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.vc.OneOffVersioned

ONE_OFF_VERSION_IDENTIFIER, ONE_OFF_VERSION_INFO

Fields inherited from interface wt.vc.Versioned

VERSION_IDENTIFIER, VERSION_INFO

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.lifecycle.LifeCycleManaged

LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.team.TeamManaged

TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAME

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ProxyDocument()
No-argument constructor returning an initialized instance of the class.

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
QueryResult	findLinks(Class targetLinkClass, String obj1Role, Persistable obj2) Return all link objects that exist between the Federated object and the specified source object.
String	getConceptualClassname() Deprecated.
long	getExpirationTime() Gets the value of the attribute: EXPIRATION_TIME.
Mastered	getMaster() Gets the object for the association that plays the role: MASTERED Supported API: true
long	getRefreshTime() Gets the value of the attribute: REFRESH_TIME.
FederatedService	getService() Return the service object referenced by the serviceId attribute.
ServiceIdentifier	getServiceId() Gets the object for the association that plays role: SERVICE_ID.
Hashtable	getSourceAttributes() Gets the value of the attribute: SOURCE_ATTRIBUTES.
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
String	getSourceObjectId() Gets the value of the attribute: SOURCE_OBJECT_ID.
String	getSourceURL() Gets the value of the attribute: SOURCE_URL.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String number, String name, DocumentType type) Supports initialization, following construction of an instance.
protected void	initialize(WTDocumentMaster master) Supports initialization, following construction of an instance.
private void	masterReferenceValidate(ObjectReference a_MasterReference)
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.
static ProxyDocument	newProxyDocument() Supported API: false
static ProxyDocument	newProxyDocument(String number, String name, DocumentType type) Supported API: false
static ProxyDocument	newProxyDocument(WTDocumentMaster master) Supported API: false
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	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ProxyDocument thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external 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.
private void	retrieveSourceAttributes() Retrieve the raw attributes of the object.
private void	serviceIdValidate(ServiceIdentifier a_ServiceId)
void	setExpirationTime(long a_ExpirationTime) Sets the value of the attribute: EXPIRATION_TIME.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
void	setRefreshTime(long a_RefreshTime) Sets the value of the attribute: REFRESH_TIME.
void	setServiceId(ServiceIdentifier a_ServiceId) Sets the object for the association that plays role: SERVICE_ID.
void	setSourceAttributes(Hashtable a_SourceAttributes) Sets the value of the attribute: SOURCE_ATTRIBUTES.
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	setSourceObjectId(String a_SourceObjectId) Sets the value of the attribute: SOURCE_OBJECT_ID.
void	setSourceURL(String a_SourceURL) Sets the value of the attribute: SOURCE_URL.
private void	sourceObjectIdValidate(String a_SourceObjectId)
private void	sourceURLValidate(String a_SourceURL)
void	update() Update the derived attributes of the object on the source service.
private void	updateContentItems() Update content items in the ProxyDocument
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.doc.WTDocument

checkAttributes, getAttributeContainer, getContainer, getContainerName, getContainerReference, getContentVector, getDepartment, getDescription, getDocType, getFederatableInfo, getFormat, getFormatName, getHttpVector, getName, getNumber, getOneOffVersionIdentifier, getOneOffVersionInfo, getOperation, getOrganization, getOrganizationCodingSystem, getOrganizationName, getOrganizationReference, getOrganizationUniqueIdentifier, getPrimary, getTemplate, getTitle, getTypeDefinitionReference, isHasContents, isTemplated, newWTDocument, newWTDocument, newWTDocument, readVersion, setAttributeContainer, setContainer, setContainerReference, setContentVector, setDepartment, setDescription, setDocType, setFederatableInfo, setFormat, setHasContents, setHttpVector, setName, setNumber, setOneOffVersionInfo, setOperation, setOrganization, setOrganizationReference, setPrimary, setTemplate, setTitle, setTypeDefinitionReference

Methods inherited from class wt.enterprise.RevisionControlled

getBranchIdentifier, getBusinessType, getCabinet, getCabinetName, getCabinetReference, getCheckoutInfo, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEntrySet, getEventSet, getFolderingInfo, getFolderPath, getIdentity, getIndexerSet, getIterationDisplayIdentifier, getIterationIdentifier, getIterationInfo, getIterationNote, getLifeCycleName, getLifeCycleState, getLifeCycleTemplate, getLocation, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOwnership, getState, getTeamId, getTeamIdentity, getTeamName, getTeamTemplateId, getTeamTemplateIdentity, getTeamTemplateName, getVersionDisplayIdentifier, getVersionDisplayIdentity, getVersionDisplayType, getVersionIdentifier, getVersionInfo, initialize, isInheritedDomain, isLatestIteration, isLifeCycleAtGate, isLifeCycleBasic, isLocked, readVersion, setCheckoutInfo, setControlBranch, setDomainRef, setEntrySet, setEventSet, setFolderingInfo, setIndexerSet, setInheritedDomain, setIterationInfo, setLock, setMaster, setOwnership, setState, setTeamId, setTeamTemplateId, setVersionInfo

Methods inherited from class wt.fc.WTObject

duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.vc.Iterated

getBranchIdentifier, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationInfo, getIterationNote, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setIterationInfo, setMaster

Methods inherited from interface wt.org.OrganizationOwnedVersion

getMasterReference, setMaster

Methods inherited from interface wt.vc.Versioned

getVersionIdentifier, getVersionInfo, setVersionInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

SOURCE_ATTRIBUTES

public static final String SOURCE_ATTRIBUTES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

sourceAttributes

private Hashtable sourceAttributes

sourceObjectId

private String sourceObjectId

sourceURL

private String sourceURL

expirationTime

private long expirationTime

refreshTime

private long refreshTime

serviceId

private ServiceIdentifier serviceId

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

master

private Mastered master

sourceContentList

private Vector sourceContentList

VERBOSE

private static boolean VERBOSE

Constructor Detail

ProxyDocument

public ProxyDocument()
              throws WTException

No-argument constructor returning an initialized instance of the class. This is needed in order to ensure that ProxyDocument objects are fully initialized when created dynamically by FederatedService objects.

Throws:

WTException

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class WTDocument

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class WTDocument

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ProxyDocument thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class WTDocument

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class WTDocument

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class WTDocument

Returns:

String

getSourceAttributes

public Hashtable getSourceAttributes()

Gets the value of the attribute: SOURCE_ATTRIBUTES.

Supported API: false

Returns:

Hashtable

setSourceAttributes

public void setSourceAttributes(Hashtable a_SourceAttributes)
                         throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_ATTRIBUTES.

Supported API: false

Parameters:

a_SourceAttributes -

Throws:

WTPropertyVetoException

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Specified by:

setMasterReference in interface Iterated

Overrides:

setMasterReference in class WTDocument

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

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 Iterated

Overrides:

getMaster in class RevisionControlled

Returns:

Mastered

See Also:

Mastered

newProxyDocument

public static ProxyDocument newProxyDocument()
                                      throws WTException

Supported API: false

Returns:

ProxyDocument

Throws:

WTException

newProxyDocument

public static ProxyDocument newProxyDocument(WTDocumentMaster master)
                                      throws WTException

Supported API: false

Parameters:

master -

Returns:

ProxyDocument

Throws:

WTException

initialize

protected void initialize(WTDocumentMaster master)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Overrides:

initialize in class WTDocument

Parameters:

master -

Throws:

WTException

newProxyDocument

public static ProxyDocument newProxyDocument(String number,
                                             String name,
                                             DocumentType type)
                                      throws WTException

Supported API: false

Parameters:

number -

name -

type -

Returns:

ProxyDocument

Throws:

WTException

initialize

protected void initialize(String number,
                          String name,
                          DocumentType type)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Overrides:

initialize in class WTDocument

Parameters:

number -

name -

type -

Throws:

WTException

getSourceObjectId

public String getSourceObjectId()

Gets the value of the attribute: SOURCE_OBJECT_ID.

Supported API: false

Specified by:

getSourceObjectId in interface Federated

Returns:

String

setSourceObjectId

public void setSourceObjectId(String a_SourceObjectId)
                       throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_OBJECT_ID.

Supported API: false

Specified by:

setSourceObjectId in interface Federated

Parameters:

a_SourceObjectId -

Throws:

WTPropertyVetoException

sourceObjectIdValidate

private void sourceObjectIdValidate(String a_SourceObjectId)
                             throws WTPropertyVetoException

Parameters:

a_SourceObjectId -

Throws:

WTPropertyVetoException

getSourceURL

public String getSourceURL()

Gets the value of the attribute: SOURCE_URL.

Supported API: false

Specified by:

getSourceURL in interface Federated

Returns:

String

setSourceURL

public void setSourceURL(String a_SourceURL)
                  throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_URL.

Supported API: false

Specified by:

setSourceURL in interface Federated

Parameters:

a_SourceURL -

Throws:

WTPropertyVetoException

sourceURLValidate

private void sourceURLValidate(String a_SourceURL)
                        throws WTPropertyVetoException

Parameters:

a_SourceURL -

Throws:

WTPropertyVetoException

getExpirationTime

public long getExpirationTime()

Gets the value of the attribute: EXPIRATION_TIME.

Supported API: false

Specified by:

getExpirationTime in interface Federated

Returns:

long

setExpirationTime

public void setExpirationTime(long a_ExpirationTime)
                       throws WTPropertyVetoException

Sets the value of the attribute: EXPIRATION_TIME.

Supported API: false

Specified by:

setExpirationTime in interface Federated

Parameters:

a_ExpirationTime -

Throws:

WTPropertyVetoException

getRefreshTime

public long getRefreshTime()

Gets the value of the attribute: REFRESH_TIME.

Supported API: false

Specified by:

getRefreshTime in interface Federated

Returns:

long

setRefreshTime

public void setRefreshTime(long a_RefreshTime)
                    throws WTPropertyVetoException

Sets the value of the attribute: REFRESH_TIME.

Supported API: false

Specified by:

setRefreshTime in interface Federated

Parameters:

a_RefreshTime -

Throws:

WTPropertyVetoException

getService

public FederatedService getService()
                            throws FederationServicesException

Return the service object referenced by the serviceId attribute.

Supported API: true

Specified by:

getService in interface Federated

Returns:

FederatedService

Throws:

FederationServicesException

preset

public void preset()
            throws 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:

FederationServicesException

refresh

public void refresh()
             throws FederationServicesException

Refresh the derived attributes of the object.

Supported API: true

Specified by:

refresh in interface Federated

Throws:

FederationServicesException

refreshIfStale

public void refreshIfStale()
                    throws 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:

FederationServicesException

update

public void update()
            throws FederationServicesException

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

Supported API: true

Specified by:

update in interface Federated

Throws:

FederationServicesException

prepareForStore

public void prepareForStore()
                     throws 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:

FederationServicesException

findLinks

public QueryResult findLinks(Class targetLinkClass,
                             String obj1Role,
                             Persistable obj2)
                      throws 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:

FederationServicesException

navigate

public QueryResult navigate(String role,
                            Class linkClass,
                            boolean onlyOtherSide)
                     throws 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:

FederationServicesException

navigate

public QueryResult navigate(String role,
                            QuerySpec criteria,
                            boolean onlyOtherSide)
                     throws 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:

FederationServicesException

postStore

public void postStore()
               throws 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:

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

serviceIdValidate

private void serviceIdValidate(ServiceIdentifier a_ServiceId)
                        throws WTPropertyVetoException

Parameters:

a_ServiceId -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class WTDocument

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class WTDocument

Returns:

int

retrieveSourceAttributes

private void retrieveSourceAttributes()
                               throws FederationServicesException

Retrieve the raw attributes of the object.

Throws:

FederationServicesException

updateContentItems

private void updateContentItems()
                         throws FederationServicesException

Update content items in the ProxyDocument

Throws:

FederationServicesException