Package org.opencms.cmis

Class CmsCmisRelationHelper.RelationKey

java.lang.Object

org.opencms.cmis.CmsCmisRelationHelper.RelationKey

Enclosing class:

CmsCmisRelationHelper

public static class CmsCmisRelationHelper.RelationKey
extends java.lang.Object

A class which contains the necessary information to identify a relation object.

Constructor Summary

Constructors

Constructor	Description
RelationKey(CmsUUID sourceId, CmsUUID targetId, java.lang.String relType)	Creates a new relation key.

Method Summary

Modifier and Type	Method	Description
void	fillRelation(CmsObject cms)	Reads the actual resource and relation data from the OpenCms VFS.
CmsRelation	getRelation()	Gets the relation object.
java.lang.String	getRelType()	Gets the relation type.
CmsResource	getSource()	Gets the source resource of the relation.
CmsUUID	getSourceId()	Gets the source id.
CmsUUID	getTargetId()	Gets the target id of the relation.
void	setRelType(java.lang.String relType)	Sets the relation type.
void	setSourceId(CmsUUID sourceId)	Sets the source id.
void	setTargetId(CmsUUID targetId)	Sets the target id.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RelationKey

public RelationKey(CmsUUID sourceId,
                   CmsUUID targetId,
                   java.lang.String relType)

Creates a new relation key.

Parameters:

sourceId - the source id

targetId - the target id

relType - the relation type

Method Detail

fillRelation

public void fillRelation(CmsObject cms)

Reads the actual resource and relation data from the OpenCms VFS.

Parameters:

cms - the CMS context to use for reading the data

getRelation

public CmsRelation getRelation()

Gets the relation object.

Returns:

the relation object

getRelType

public java.lang.String getRelType()

Gets the relation type.

Returns:

the relation type

getSource

public CmsResource getSource()

Gets the source resource of the relation.

Returns:

the source of the relation

getSourceId

public CmsUUID getSourceId()

Gets the source id.

Returns:

the source id

getTargetId

public CmsUUID getTargetId()

Gets the target id of the relation.

Returns:

the target id

setRelType

public void setRelType(java.lang.String relType)

Sets the relation type.

Parameters:

relType - the relation type

setSourceId

public void setSourceId(CmsUUID sourceId)

Sets the source id.

Parameters:

sourceId - the source id

setTargetId

public void setTargetId(CmsUUID targetId)

Sets the target id.

Parameters:

targetId - the target id

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()