|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public static final java.lang.String RELATIONSHIP_FROM_TYPE_SYMNAME
public static final java.lang.String RELATIONSHIP_FROM_ID_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_TYPE_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_ID_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_VERSION_ID_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_EXT_OBJECT_STORE_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_EXT_ID_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_EXT_VERSION_ID_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_EXT_URL_SYMNAME
public static final java.lang.String RELATIONSHIP_TO_VERSIONING_TYPE_SYMNAME
public static final java.lang.String RELATIONSHIP_TWO_WAY_OTHER_ID_SYMNAME
public static final java.lang.String IS_RELATIONSHIP_PROTECTED_SYMNAME
public static final java.lang.String COLLABORATIONTYPE_SYMNAME
public static final java.lang.String DATECREATED_SYMNAME
public static final java.lang.String DIRECTCONTAINER_SYMNAME
public static final java.lang.String ID_SYMNAME
public static final java.lang.String TEAMSPACE_SYMNAME
public static final java.lang.String TITLE_SYMNAME
public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
public static final java.lang.String SECURITYOWNERID_SYMNAME
public static final int RELATIONSHIP_TITLE_MAX
public static final int RELTYPE_LOCAL_DOCUMENT
public static final int RELTYPE_LOCAL_FOLDER
public static final int RELTYPE_LOCAL_CUSTOMOBJECT
public static final int RELTYPE_EXTERNAL_OBJECT_STORE
public static final int RELTYPE_EXTERNAL_DOCUMENT
public static final int RELTYPE_EXTERNAL_FOLDER
public static final int RELTYPE_EXTERNAL_CUSTOMOBJECT
public static final int RELTYPE_EXTERNAL_URL
public static final int RELTYPE_BEGINNING
public static final int RELTYPE_END
public static final java.lang.String RELEASED_VERSION
public static final java.lang.String[] PROPERTIES
public static final java.lang.String[] QUERYPROPERTIES
Method Detail |
public java.lang.String getTitle()
getToTitle
method, which returns the title of the to-end object.public int getRelationshipFromType()
Relationship.RELTYPE
constant.public java.lang.String getRelationshipFromID()
public int getRelationshipToType()
Relationship.RELTYPE
constant. Use getToCollabType
for the
collaboration type of the to-end.public java.lang.String getRelationshipToID()
getToID
to get a corrected ID that properly reflects the document ID for
document-based collaboration objects. Returns null
for external
relationships.public java.lang.String getRelationshipToVersionID()
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.public java.lang.String getRelationshipToExtObjectStore()
null
for objects
(except custom objects) that are in the same object store as the relationship.public java.lang.String getRelationshipToExtID()
null
for external object
store relationships and also for objects (except custom objects) that are in the same
object store as the relationship.public java.lang.String getRelationshipToExtVersionID()
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.public java.lang.String getRelationshipToExtURL()
null
is returned.public java.lang.String getRelationshipTwoWayOtherID()
null
.public boolean isRelationshipProtected()
true
,
the method RelationshipManager.removeRelationship
will not attempt to remove this
relationship.public java.lang.String getToTitle()
RelationshipManager
's getRelationships
or
getAllRelationships
methods.public java.lang.String getToID()
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.public java.lang.String getToDocumentID()
RelationshipManager
's
getRelationships
or getAllRelationships
methods, and if the
to-end object is a document in the same object store as the relationship.public int getToCollabType()
RelationshipManager
's getRelationships
or
getAllRelationships
methods. Returns zero if the CollaborationType property
cannot be determined.public int getToObjectType()
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.public java.lang.String getToTeamspaceID()
RelationshipManager
's
getRelationships
or getAllRelationships
methods and the object
has the teamspace property set.public Teamspace getTeamspace()
public filenet.vw.api.VWAttachment toVWAttachment()
VWAttachment
object.VWAttachment
that can be used in a workflow.public boolean supportsVWAttachment()
VWAttachment
.true
if the Relationship object can be converted.public RelationshipInfo toRelationshipInfo()
RelationshipInfo
object.RelationshipInfo
object.public boolean matchesVWAttachment(filenet.vw.api.VWAttachment otherAttachment)
VWAttachment
object. Some
of the attachment fields are ignored in the test, like the attachment name, and others
need only be functionally equivalent.otherAttachment
- The attachment against which the relationship object is compared.true
if the relationship matches the attachment.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |