org.kuali.student.core.document.dto
Class RefDocRelationInfo

java.lang.Object
  org.kuali.student.core.document.dto.RefDocRelationInfo

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

public class RefDocRelationInfo
extends Object
implements Serializable, Idable, HasTypeState, HasAttributes

Information about the object to document relation.

See Also:

Serialized Form

Field Summary

private Map<String,String>	attributes
private RichTextInfo	desc
private String	documentId
private Date	effectiveDate
private Date	expirationDate
private String	id
private MetaInfo	metaInfo
private String	refObjectId
private String	refObjectTypeKey
private static long	serialVersionUID
private String	state
private String	title
private String	type

Constructor Summary

RefDocRelationInfo()

Method Summary

Map<String,String>	getAttributes() List of key/value pairs, typically used for dynamic attributes.
RichTextInfo	getDesc() The description of the document usage in the context of the relation to the object.
String	getDocumentId() Unique identifier for a document.
Date	getEffectiveDate() Date and time that this Object Doc Relation became effective.
Date	getExpirationDate() Date and time that this Object Doc Relation expires.
String	getId() Unique identifier for a LU to document relation.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getRefObjectId() Identifier for an object.
String	getRefObjectTypeKey() Unique identifier for an object type.
String	getState() The current status of the object to document relationship.
String	getTitle() The title of the document usage in the context of the relation to the object.
String	getType() Unique identifier for an object/document relationship type.
void	setAttributes(Map<String,String> attributes)
void	setDesc(RichTextInfo desc)
void	setDocumentId(String documentId)
void	setEffectiveDate(Date effectiveDate)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setMetaInfo(MetaInfo metaInfo)
void	setRefObjectId(String refObjectId)
void	setRefObjectTypeKey(String refObjectTypeKey)
void	setState(String state)
void	setTitle(String title)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

refObjectTypeKey

private String refObjectTypeKey

refObjectId

private String refObjectId

documentId

private String documentId

title

private String title

desc

private RichTextInfo desc

effectiveDate

private Date effectiveDate

expirationDate

private Date expirationDate

attributes

private Map<String,String> attributes

metaInfo

private MetaInfo metaInfo

type

private String type

state

private String state

id

private String id

Constructor Detail

RefDocRelationInfo

public RefDocRelationInfo()

Method Detail

getRefObjectTypeKey

public String getRefObjectTypeKey()

Unique identifier for an object type. Used to identify the type of object being referred to, so that the id can be resolved.

setRefObjectTypeKey

public void setRefObjectTypeKey(String refObjectTypeKey)

getRefObjectId

public String getRefObjectId()

Identifier for an object. This will likely require some additional context in order to be resolved, such as the type of object. An objectId could be a cluId, a luiId, an orgId, a documentId, etc.

setRefObjectId

public void setRefObjectId(String refObjectId)

getDocumentId

public String getDocumentId()

Unique identifier for a document.

setDocumentId

public void setDocumentId(String documentId)

getTitle

public String getTitle()

The title of the document usage in the context of the relation to the object.

setTitle

public void setTitle(String title)

getDesc

public RichTextInfo getDesc()

The description of the document usage in the context of the relation to the object.

setDesc

public void setDesc(RichTextInfo desc)

getEffectiveDate

public Date getEffectiveDate()

Date and time that this Object Doc Relation became effective. This is a similar concept to the effective date on enumerated values. When an expiration date has been specified, this field must be less than or equal to the expiration date.

setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

getExpirationDate

public Date getExpirationDate()

Date and time that this Object Doc Relation expires. This is a similar concept to the expiration date on enumerated values. If specified, this should be greater than or equal to the effective date. If this field is not specified, then no expiration date has been currently defined and should automatically be considered greater than the effective date.

setExpirationDate

public void setExpirationDate(Date expirationDate)

getAttributes

public Map<String,String> getAttributes()

List of key/value pairs, typically used for dynamic attributes.

Specified by:

getAttributes in interface HasAttributes

setAttributes

public void setAttributes(Map<String,String> attributes)

Specified by:

setAttributes in interface HasAttributes

getMetaInfo

public MetaInfo getMetaInfo()

Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations.

setMetaInfo

public void setMetaInfo(MetaInfo metaInfo)

getType

public String getType()

Unique identifier for an object/document relationship type. Describes the type of usage of the document.

Specified by:

getType in interface HasTypeState

setType

public void setType(String type)

Specified by:

setType in interface HasTypeState

getState

public String getState()

The current status of the object to document relationship. The values for this field are constrained to those in the refDocRelationState enumeration. A separate setup operation does not exist for retrieval of the meta data around this value.

Specified by:

getState in interface HasTypeState

setState

public void setState(String state)

Specified by:

setState in interface HasTypeState

getId

public String getId()

Unique identifier for a LU to document relation. This is optional, due to the identifier being set at the time of creation. Once the connection has been created, this should be seen as required.

Specified by:

getId in interface Idable

setId

public void setId(String id)

Specified by:

setId in interface Idable