Content Engine Java API: Link

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
```
public interface Link
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
```
Represents a relationship between two objects. The object-valued Head and Tail properties express the relationship. Use a Link object for many-to-many relationships between any objects, or for referential containment relationships between objects that are not instances of Containable subclasses.
Note This is a weak link relationship: both the Head and Tail properties have their DeletionAction metadata properties set to None. If you delete the object referenced by the head or tail, the Link object itself is not deleted.

Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable

See Also:
ReferentialContainmentRelationship, DynamicReferentialContainmentRelationship

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`changeClass(java.lang.String className)` Changes the class of a Content Engine object.
`ActiveMarkingList`	`get_ActiveMarkings()` Returns the value of the ActiveMarkings property.
`EventSet`	`get_AuditedEvents()` Returns the value of the AuditedEvents property.
`java.lang.Boolean`	`get_CmIsMarkedForDeletion()` Returns the value of the CmIsMarkedForDeletion property.
`java.lang.String`	`get_Creator()` Returns the value of the Creator property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`java.util.Date`	`get_DateLastModified()` Returns the value of the DateLastModified property.
`IndependentObject`	`get_Head()` Returns the value of the Head property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`java.lang.String`	`get_Name()` Returns the value of the Name property.
`java.lang.String`	`get_Owner()` Returns the value of the Owner property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`IndependentObject`	`get_Tail()` Returns the value of the Tail property.
`void`	`set_Creator(java.lang.String value)` Sets the value of the Creator property.
`void`	`set_DateCreated(java.util.Date value)` Sets the value of the DateCreated property.
`void`	`set_DateLastModified(java.util.Date value)` Sets the value of the DateLastModified property.
`void`	`set_Head(IndependentObject value)` Sets the value of the Head property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_Owner(java.lang.String value)` Sets the value of the Owner property.
`void`	`set_Permissions(AccessPermissionList value)` Sets the value of the Permissions property.
`void`	`set_Tail(IndependentObject value)` Sets the value of the Tail property.

Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore

Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - set_LastModifier
```
void set_LastModifier(java.lang.String value)
```
    Sets the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - set_DateLastModified
```
void set_DateLastModified(java.util.Date value)
```
    Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_Name
```
java.lang.String get_Name()
```
    Returns the value of the Name property. For more information, see Name Property.
  - get_AuditedEvents
```
EventSet get_AuditedEvents()
```
    Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.
  - get_Owner
```
java.lang.String get_Owner()
```
    Returns the value of the Owner property. For more information, see Owner Property.
  - set_Owner
```
void set_Owner(java.lang.String value)
```
    Sets the value of the Owner property. For more information, see Owner Property.
  - get_Permissions
```
AccessPermissionList get_Permissions()
```
    Returns the value of the Permissions property. For more information, see Permissions Property.
  - set_Permissions
```
void set_Permissions(AccessPermissionList value)
```
    Sets the value of the Permissions property. For more information, see Permissions Property.
  - get_ActiveMarkings
```
ActiveMarkingList get_ActiveMarkings()
```
    Returns the value of the ActiveMarkings property. For more information, see ActiveMarkings Property.
  - get_Head
```
IndependentObject get_Head()
```
    Returns the value of the Head property. For more information, see Head Property.
  - set_Head
```
void set_Head(IndependentObject value)
```
    Sets the value of the Head property. For more information, see Head Property.
  - get_Tail
```
IndependentObject get_Tail()
```
    Returns the value of the Tail property. For more information, see Tail Property.
  - set_Tail
```
void set_Tail(IndependentObject value)
```
    Sets the value of the Tail property. For more information, see Tail Property.
  - get_CmIsMarkedForDeletion
```
java.lang.Boolean get_CmIsMarkedForDeletion()
```
    Returns the value of the CmIsMarkedForDeletion property. For more information, see CmIsMarkedForDeletion Property.
  - changeClass
```
void changeClass(java.lang.String className)
```
    Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The changeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
    - Any user-defined properties that exist in the new class but not in the original class are set to the default value defined by the new class (or to null if there is no default defined).
    - Any user-defined properties that exist in both the original and the new class that are writable and have the same value (including null) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class.
    - Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.
    - Property constraints for the new class (for example, required values, choice lists, ranges) are not enforced.
    When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:
    - The document has no current lifecycle policy.
    - The document is either a reservation object, or is the current version object and is not reserved.
    Changing the document class of a document object has no effect on the storage location of the document�s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer�s Guide.
    Parameters:
    className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
    
    Throws:
    
    E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.

Methods inherited from interface com.filenet.api.core.RepositoryObject

Methods inherited from interface com.filenet.api.replication.Replicable

Methods inherited from interface com.filenet.api.core.Subscribable

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

Methods inherited from interface com.filenet.api.core.IndependentObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

set_LastModifier

get_DateLastModified

set_DateLastModified

get_Id

get_Name

get_AuditedEvents

get_Owner

set_Owner

get_Permissions

set_Permissions

get_ActiveMarkings

get_Head

set_Head

get_Tail

set_Tail

get_CmIsMarkedForDeletion

changeClass