org.kuali.student.core.statement.dto
Class RefStatementRelationInfo

java.lang.Object
  org.kuali.student.core.statement.dto.RefStatementRelationInfo

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

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

See Also:

Serialized Form

Field Summary

private Map<String,String>	attributes
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	statementId
private String	type

Constructor Summary

RefStatementRelationInfo()

Method Summary

Map<String,String>	getAttributes() Gets the list of key/value pairs, typically used for dynamic attributes.
Date	getEffectiveDate() Gets the date and time that this object to statement relationship became effective.
Date	getExpirationDate() Gets the date and time that this object to statement relationship expires.
String	getId() Gets the unique identifier for a single Object Statement Relationship record.
MetaInfo	getMetaInfo() Gets the create and last update info for the structure.
String	getRefObjectId() Sets the identifier for an object.
String	getRefObjectTypeKey() Gets the unique identifier for an object type.
String	getState() Gets the identifier for the current status of the object to statement relationship.
String	getStatementId() Gets the unique identifier for a single statement record.
String	getType() Gets the object to statement relation type.
void	setAttributes(Map<String,String> attributes) Sets the list of key/value pairs, typically used for dynamic attributes.
void	setEffectiveDate(Date effectiveDate) Sets the date and time that this object to statement relationship became effective.
void	setExpirationDate(Date expirationDate) Sets the date and time that this object to statement relationship expires.
void	setId(String id) Sets the unique identifier for a single Object Statement Relationship record.
void	setMetaInfo(MetaInfo metaInfo) Sets the create and last update info for the structure.
void	setRefObjectId(String refObjectId) Gets the identifier for an object.
void	setRefObjectTypeKey(String refObjectTypeKey) Sets the unique identifier for an object type.
void	setState(String state) Sets the identifier for the current status of the object to statement relationship.
void	setStatementId(String statementId) Sets the unique identifier for a single statement record.
void	setType(String type) Sets the object to statement relation type.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

refObjectTypeKey

private String refObjectTypeKey

refObjectId

private String refObjectId

statementId

private String statementId

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

RefStatementRelationInfo

public RefStatementRelationInfo()

Method Detail

getRefObjectTypeKey

public String getRefObjectTypeKey()

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

Returns:

Reference object type key

setRefObjectTypeKey

public void setRefObjectTypeKey(String refObjectTypeKey)

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

Parameters:

refObjectTypeKey - Reference object type key

getRefObjectId

public String getRefObjectId()

Sets the 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.

Returns:

Reference object id

setRefObjectId

public void setRefObjectId(String refObjectId)

Gets the 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.

Parameters:

refObjectId - Reference object id

getStatementId

public String getStatementId()

Gets the unique identifier for a single statement record.

Returns:

setStatementId

public void setStatementId(String statementId)

Sets the unique identifier for a single statement record.

Parameters:

statementId - Statement id

getEffectiveDate

public Date getEffectiveDate()

Gets the date and time that this object to statement relationship 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.

Returns:

Object to statement relationship effective date

setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

Sets the date and time that this object to statement relationship 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.

Parameters:

effectiveDate - Object to statement relationship effective date

getExpirationDate

public Date getExpirationDate()

Gets the date and time that this object to statement relationship 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.

Returns:

Object to statement relationship expiration date

setExpirationDate

public void setExpirationDate(Date expirationDate)

Sets the date and time that this object to statement relationship 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.

Parameters:

expirationDate - Object to statement relationship expiration date

getAttributes

public Map<String,String> getAttributes()

Gets the list of key/value pairs, typically used for dynamic attributes.

Specified by:

getAttributes in interface HasAttributes

Returns:

Map of attributes

setAttributes

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

Sets the list of key/value pairs, typically used for dynamic attributes.

Specified by:

setAttributes in interface HasAttributes

Parameters:

attributes - Map of attributes

getMetaInfo

public MetaInfo getMetaInfo()

Gets the 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.

Returns:

Meta data information

setMetaInfo

public void setMetaInfo(MetaInfo metaInfo)

Sets the 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.

Parameters:

metaInfo - Meta data information

getType

public String getType()

Gets the object to statement relation type.

Specified by:

getType in interface HasTypeState

Returns:

Object to statement relation type

setType

public void setType(String type)

Sets the object to statement relation type.

Specified by:

setType in interface HasTypeState

Parameters:

type - Object to statement relation type

getState

public String getState()

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

Specified by:

getState in interface HasTypeState

Returns:

Object to statement relation state

setState

public void setState(String state)

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

Specified by:

setState in interface HasTypeState

Parameters:

state - Object to statement relation state

getId

public String getId()

Gets the unique identifier for a single Object Statement Relationship record.

Specified by:

getId in interface Idable

Returns:

Object to Statement Relation Identifier

setId

public void setId(String id)

Sets the unique identifier for a single Object Statement Relationship record.

Specified by:

setId in interface Idable

Parameters:

id - Object to statement relation identifier

toString

public String toString()

Overrides:

toString in class Object