Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Relationship

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface Relationship
extends CollaborationObject, PersistentBaseObject

Classes that implement the Relationship interface represent the relationship between related items.


Field Summary
static java.lang.String COLLABORATIONTYPE_SYMNAME
           
static java.lang.String DATECREATED_SYMNAME
           
static java.lang.String DIRECTCONTAINER_SYMNAME
           
static java.lang.String ID_SYMNAME
           
static java.lang.String IS_RELATIONSHIP_PROTECTED_SYMNAME
           
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
           
static java.lang.String[] PROPERTIES
          String array of Relationship persistent property names.
static java.lang.String[] QUERYPROPERTIES
          String array of Relationship persistent property names that may be queried.
static java.lang.String RELATIONSHIP_FROM_ID_SYMNAME
           
static java.lang.String RELATIONSHIP_FROM_TYPE_SYMNAME
           
static int RELATIONSHIP_TITLE_MAX
           
static java.lang.String RELATIONSHIP_TO_EXT_ID_SYMNAME
           
static java.lang.String RELATIONSHIP_TO_EXT_OBJECT_STORE_SYMNAME
           
static java.lang.String RELATIONSHIP_TO_EXT_URL_SYMNAME
           
static java.lang.String RELATIONSHIP_TO_EXT_VERSION_ID_SYMNAME
           
static java.lang.String RELATIONSHIP_TO_ID_SYMNAME
           
static java.lang.String RELATIONSHIP_TO_TYPE_SYMNAME
           
static java.lang.String RELATIONSHIP_TO_VERSION_ID_SYMNAME
           
static java.lang.String RELATIONSHIP_TO_VERSIONING_TYPE_SYMNAME
           
static java.lang.String RELATIONSHIP_TWO_WAY_OTHER_ID_SYMNAME
           
static java.lang.String RELEASED_VERSION
           
static int RELTYPE_BEGINNING
           
static int RELTYPE_END
           
static int RELTYPE_EXTERNAL_CUSTOMOBJECT
           
static int RELTYPE_EXTERNAL_DOCUMENT
           
static int RELTYPE_EXTERNAL_FOLDER
           
static int RELTYPE_EXTERNAL_OBJECT_STORE
           
static int RELTYPE_EXTERNAL_URL
           
static int RELTYPE_LOCAL_CUSTOMOBJECT
           
static int RELTYPE_LOCAL_DOCUMENT
           
static int RELTYPE_LOCAL_FOLDER
           
static java.lang.String SECURITYOWNERID_SYMNAME
           
static java.lang.String TEAMSPACE_SYMNAME
           
static java.lang.String TITLE_SYMNAME
           
 
Method Summary
 java.lang.String getRelationshipFromID()
          Return the relationship's from-end ID property.
 int getRelationshipFromType()
          Return the relationship's from-end type property.
 java.lang.String getRelationshipToExtID()
          Return the relationship's to-end external ID property for to-end objects that are outside the relationship's object store.
 java.lang.String getRelationshipToExtObjectStore()
          Return the relationship's to-end external object store ID property for to-end objects that are outside the relationship's object store.
 java.lang.String getRelationshipToExtURL()
          Return the to-end external URL property for relationship that relate to URLs.
 java.lang.String getRelationshipToExtVersionID()
          Return the relationship's to-end external version ID.
 java.lang.String getRelationshipToID()
          Return the relationship's to-end ID if this is to an object in the same object store as the relationship.
 int getRelationshipToType()
          Return the relationship's to-end type.
 java.lang.String getRelationshipToVersionID()
          Return the relationship's to-end version ID.
 java.lang.String getRelationshipTwoWayOtherID()
          Return the relationship's two-way other ID property.
 Teamspace getTeamspace()
          Return the relationship's teamspace.
 java.lang.String getTitle()
          Return the relationship's title property, if one has been set.
 int getToCollabType()
          Return the CollaborationType property attached to the relationship's to-end object if that object is in the same object store as the relationship and has the CollaborationType property set.
 java.lang.String getToDocumentID()
          Return the document ID of the to-end object.
 java.lang.String getToID()
          Return the ID of the to-end object if that object is in the same object store as the relationship.
 int getToObjectType()
          Return the apparent object type of the to-end object if that object is in the same object store as the relationship.
 java.lang.String getToTeamspaceID()
          Return the teamspace ID, if any, of the object on the to-end of a relationship, provided that object is in the same object store as the relationship.
 java.lang.String getToTitle()
          Return the "title" of the to-end object if that object is in the same object store as the relationship.
 boolean isRelationshipProtected()
          Return the protected status of the relationship.
 boolean matchesVWAttachment(filenet.vw.api.VWAttachment otherAttachment)
          Test if the current relationship object matches a VWAttachment object.
 boolean supportsVWAttachment()
          Return true if this Relationship object can be converted into a VWAttachment.
 RelationshipInfo toRelationshipInfo()
          Convert this relationship into a RelationshipInfo object.
 filenet.vw.api.VWAttachment toVWAttachment()
          Convert this relationship into a VWAttachment object.
 
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject
getSymbolicName, getType
 
Methods inherited from interface com.filenet.bso.api.collaboration.PersistentBaseObject
getBaseObject, getID, getObjectStore, getProperties, isMembershipManagedSecurity, isOwner, refresh, setProperties
 

Field Detail

RELATIONSHIP_FROM_TYPE_SYMNAME

public static final java.lang.String RELATIONSHIP_FROM_TYPE_SYMNAME

RELATIONSHIP_FROM_ID_SYMNAME

public static final java.lang.String RELATIONSHIP_FROM_ID_SYMNAME

RELATIONSHIP_TO_TYPE_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_TYPE_SYMNAME

RELATIONSHIP_TO_ID_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_ID_SYMNAME

RELATIONSHIP_TO_VERSION_ID_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_VERSION_ID_SYMNAME

RELATIONSHIP_TO_EXT_OBJECT_STORE_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_EXT_OBJECT_STORE_SYMNAME

RELATIONSHIP_TO_EXT_ID_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_EXT_ID_SYMNAME

RELATIONSHIP_TO_EXT_VERSION_ID_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_EXT_VERSION_ID_SYMNAME

RELATIONSHIP_TO_EXT_URL_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_EXT_URL_SYMNAME

RELATIONSHIP_TO_VERSIONING_TYPE_SYMNAME

public static final java.lang.String RELATIONSHIP_TO_VERSIONING_TYPE_SYMNAME

RELATIONSHIP_TWO_WAY_OTHER_ID_SYMNAME

public static final java.lang.String RELATIONSHIP_TWO_WAY_OTHER_ID_SYMNAME

IS_RELATIONSHIP_PROTECTED_SYMNAME

public static final java.lang.String IS_RELATIONSHIP_PROTECTED_SYMNAME

COLLABORATIONTYPE_SYMNAME

public static final java.lang.String COLLABORATIONTYPE_SYMNAME

DATECREATED_SYMNAME

public static final java.lang.String DATECREATED_SYMNAME

DIRECTCONTAINER_SYMNAME

public static final java.lang.String DIRECTCONTAINER_SYMNAME

ID_SYMNAME

public static final java.lang.String ID_SYMNAME

TEAMSPACE_SYMNAME

public static final java.lang.String TEAMSPACE_SYMNAME

TITLE_SYMNAME

public static final java.lang.String TITLE_SYMNAME

MEMBERSHIPMANAGEDSECURITY_SYMNAME

public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME

SECURITYOWNERID_SYMNAME

public static final java.lang.String SECURITYOWNERID_SYMNAME

RELATIONSHIP_TITLE_MAX

public static final int RELATIONSHIP_TITLE_MAX

RELTYPE_LOCAL_DOCUMENT

public static final int RELTYPE_LOCAL_DOCUMENT

RELTYPE_LOCAL_FOLDER

public static final int RELTYPE_LOCAL_FOLDER

RELTYPE_LOCAL_CUSTOMOBJECT

public static final int RELTYPE_LOCAL_CUSTOMOBJECT

RELTYPE_EXTERNAL_OBJECT_STORE

public static final int RELTYPE_EXTERNAL_OBJECT_STORE

RELTYPE_EXTERNAL_DOCUMENT

public static final int RELTYPE_EXTERNAL_DOCUMENT

RELTYPE_EXTERNAL_FOLDER

public static final int RELTYPE_EXTERNAL_FOLDER

RELTYPE_EXTERNAL_CUSTOMOBJECT

public static final int RELTYPE_EXTERNAL_CUSTOMOBJECT

RELTYPE_EXTERNAL_URL

public static final int RELTYPE_EXTERNAL_URL

RELTYPE_BEGINNING

public static final int RELTYPE_BEGINNING

RELTYPE_END

public static final int RELTYPE_END

RELEASED_VERSION

public static final java.lang.String RELEASED_VERSION

PROPERTIES

public static final java.lang.String[] PROPERTIES
String array of Relationship persistent property names.

QUERYPROPERTIES

public static final java.lang.String[] QUERYPROPERTIES
String array of Relationship persistent property names that may be queried.
Method Detail

getTitle

public java.lang.String getTitle()
Return the relationship's title property, if one has been set. Also see the getToTitle method, which returns the title of the to-end object.
Returns:
The relationship title string.

getRelationshipFromType

public int getRelationshipFromType()
Return the relationship's from-end type property. This will always be a Relationship.RELTYPE constant.
Returns:
The relationship's from-end type.

getRelationshipFromID

public java.lang.String getRelationshipFromID()
Return the relationship's from-end ID property. This will be the raw ID that is in the relationship object (for document-based objects, a version series ID, rather than the document ID).
Returns:
The relationship's from-end ID, if set.

getRelationshipToType

public int getRelationshipToType()
Return the relationship's to-end type. This will always be a Relationship.RELTYPE constant. Use getToCollabType for the collaboration type of the to-end.
Returns:
The relationship's to-end type.

getRelationshipToID

public java.lang.String getRelationshipToID()
Return the relationship's to-end ID if this is to an object in the same object store as the relationship. This will be the raw ID that is in the relationship object, which means this will be a version series ID for a document-based collaboration object (rather than the object's document ID). Use getToID to get a corrected ID that properly reflects the document ID for document-based collaboration objects. Returns null for external relationships.
Returns:
The relationship's to-end ID.

getRelationshipToVersionID

public java.lang.String getRelationshipToVersionID()
Return the relationship's to-end version ID. This is only non-null if the to-end is to a local, same-object-store document object and some version other than the current version is required. In this case the value returned is the GUID for a particular document or the constant, RELEASED_VERSION, for the latest released version.
Returns:
The relationship's to-end version ID.

getRelationshipToExtObjectStore

public java.lang.String getRelationshipToExtObjectStore()
Return the relationship's to-end external object store ID property for to-end objects that are outside the relationship's object store. This will be null for objects (except custom objects) that are in the same object store as the relationship.
Returns:
The relationship's external object store ID. This ID may be either a GUID or a name.

getRelationshipToExtID

public java.lang.String getRelationshipToExtID()
Return the relationship's to-end external ID property for to-end objects that are outside the relationship's object store. This will be null for external object store relationships and also for objects (except custom objects) that are in the same object store as the relationship.
Returns:
The relationship's to-end external ID.

getRelationshipToExtVersionID

public java.lang.String getRelationshipToExtVersionID()
Return the relationship's to-end external version ID. This is only non-null if the to-end is to an external document object and some version other than the current version is required. In such a case the value returned is the GUID for a particular document, or the constant RELEASED_VERSION for the latest released version.
Returns:
The relationship's to-end external version ID.

getRelationshipToExtURL

public java.lang.String getRelationshipToExtURL()
Return the to-end external URL property for relationship that relate to URLs. For all other relationship types, null is returned.
Returns:
The to-end external URL.

getRelationshipTwoWayOtherID

public java.lang.String getRelationshipTwoWayOtherID()
Return the relationship's two-way other ID property. This currently is unused and will always be null.
Returns:
The relationship's two-way other ID.

isRelationshipProtected

public boolean isRelationshipProtected()
Return the protected status of the relationship. If true, the method RelationshipManager.removeRelationship will not attempt to remove this relationship.
Returns:
A flag indicating the protected status of the relationship.

getToTitle

public java.lang.String getToTitle()
Return the "title" of the to-end object if that object is in the same object store as the relationship. This will only be non-null if this relationship was returned by the RelationshipManager's getRelationships or getAllRelationships methods.
Returns:
The "title" of the relationship's to-end object.

getToID

public java.lang.String getToID()
Return the ID of the to-end object if that object is in the same object store as the relationship. This is often the same value as returned by getRelationshipToID, but will be a document ID rather than a version series ID for document-base collaboration objects, like tasks. It will, however, be the version series ID for plain, non-collaboration documents. This will only be non-null if this relationship was returned by the RelationshipManager's getRelationships or getAllRelationships methods.
Returns:
The ID of the relationship's to-end object.

getToDocumentID

public java.lang.String getToDocumentID()
Return the document ID of the to-end object. This is non-null only if this relationship was returned by the RelationshipManager's getRelationships or getAllRelationships methods, and if the to-end object is a document in the same object store as the relationship.
Returns:
The document ID of the relationship's to-end object, if applicable.

getToCollabType

public int getToCollabType()
Return the CollaborationType property attached to the relationship's to-end object if that object is in the same object store as the relationship and has the CollaborationType property set. This is set only if this relationship was returned by the RelationshipManager's getRelationships or getAllRelationships methods. Returns zero if the CollaborationType property cannot be determined.
Returns:
The CollaborationType property of the relationship's to-end object.

getToObjectType

public int getToObjectType()
Return the apparent object type of the to-end object if that object is in the same object store as the relationship. This is similar to getToCollabType, but this method returns the underlying base-object type (TYPE_VERSIONSERIES, TYPE_FOLDER or TYPE_CUSTOMOBJECT) for those objects that do not have a CollaborationType property set. If the object does have a CollaborationType property, then that property is returned. This is set only if this relationship was returned by the RelationshipManager's getRelationships or getAllRelationships methods and the object is in the same object store as the relationship. Otherwise it returns zero.
Returns:
The to-end object type.

getToTeamspaceID

public java.lang.String getToTeamspaceID()
Return the teamspace ID, if any, of the object on the to-end of a relationship, provided that object is in the same object store as the relationship. This will only be non-null if this relationship was returned by the RelationshipManager's getRelationships or getAllRelationships methods and the object has the teamspace property set.
Returns:
The teamspace ID of the object on the to-end of a relationship.

getTeamspace

public Teamspace getTeamspace()
Return the relationship's teamspace.
Returns:
The relationship's teamspace.

toVWAttachment

public filenet.vw.api.VWAttachment toVWAttachment()
Convert this relationship into a VWAttachment object.
Returns:
A VWAttachment that can be used in a workflow.

supportsVWAttachment

public boolean supportsVWAttachment()
Return true if this Relationship object can be converted into a VWAttachment.
Returns:
true if the Relationship object can be converted.

toRelationshipInfo

public RelationshipInfo toRelationshipInfo()
Convert this relationship into a RelationshipInfo object.
Returns:
The converted RelationshipInfo object.

matchesVWAttachment

public boolean matchesVWAttachment(filenet.vw.api.VWAttachment otherAttachment)
Test if the current relationship object matches a VWAttachment object. Some of the attachment fields are ignored in the test, like the attachment name, and others need only be functionally equivalent.
Parameters:
otherAttachment - The attachment against which the relationship object is compared.
Returns:
true if the relationship matches the attachment.

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.