org.kuali.student.lum.lu.dto
Class CluCluRelationInfo

java.lang.Object
  extended by org.kuali.student.lum.lu.dto.CluCluRelationInfo
All Implemented Interfaces:
Serializable, HasAttributes, HasTypeState, Idable

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

Detailed information about a CLU to CLU relationship.

See Also:
Serialized Form

Field Summary
private  Map<String,String> attributes
           
private  String cluId
           
private  Date effectiveDate
           
private  Date expirationDate
           
private  String id
           
private  Boolean isCluRelationRequired
           
private  MetaInfo metaInfo
           
private  String relatedCluId
           
private static long serialVersionUID
           
private  String state
           
private  String type
           
 
Constructor Summary
CluCluRelationInfo()
           
 
Method Summary
 Map<String,String> getAttributes()
          List of key/value pairs, typically used for dynamic attributes.
 String getCluId()
          Unique identifier for a Canonical Learning Unit (CLU).
 Date getEffectiveDate()
          Date and time that this CLU to CLU relationship became effective.
 Date getExpirationDate()
          Date and time that this CLU to CLU relationship expires.
 String getId()
          Unique identifier for a CLU to CLU relationship.
 Boolean getIsCluRelationRequired()
          Indicates if the relation is required upon instantiation of a LUI.
 MetaInfo getMetaInfo()
          Create and last update info for the structure.
 String getRelatedCluId()
          Unique identifier for a Canonical Learning Unit (CLU).
 String getState()
          Identifier for the current status of a CLU to CLU relationship.
 String getType()
          Unique identifier for the LU to LU relation type.
 void setAttributes(Map<String,String> attributes)
           
 void setCluId(String cluId)
           
 void setEffectiveDate(Date effectiveDate)
           
 void setExpirationDate(Date expirationDate)
           
 void setId(String id)
           
 void setIsCluRelationRequired(Boolean isCluRelationRequired)
           
 void setMetaInfo(MetaInfo metaInfo)
           
 void setRelatedCluId(String relatedCluId)
           
 void setState(String state)
           
 void setType(String 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

cluId

private String cluId

relatedCluId

private String relatedCluId

isCluRelationRequired

private Boolean isCluRelationRequired

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

CluCluRelationInfo

public CluCluRelationInfo()
Method Detail

getCluId

public String getCluId()
Unique identifier for a Canonical Learning Unit (CLU).


setCluId

public void setCluId(String cluId)

getRelatedCluId

public String getRelatedCluId()
Unique identifier for a Canonical Learning Unit (CLU).


setRelatedCluId

public void setRelatedCluId(String relatedCluId)

getIsCluRelationRequired

public Boolean getIsCluRelationRequired()
Indicates if the relation is required upon instantiation of a LUI. Default is "true".


setIsCluRelationRequired

public void setIsCluRelationRequired(Boolean isCluRelationRequired)

getEffectiveDate

public Date getEffectiveDate()
Date and time that this CLU to CLU 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.


setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

getExpirationDate

public Date getExpirationDate()
Date and time that this CLU to CLU 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.


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 the LU to LU relation type.

Specified by:
getType in interface HasTypeState

setType

public void setType(String type)
Specified by:
setType in interface HasTypeState

getState

public String getState()
Identifier for the current status of a CLU to CLU relationship. The values for this field are constrained to those in the luLuRelationState 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 CLU to CLU relationship. This is optional, due to the identifier being set at the time of creation. Once the relation 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

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2004-2011 The Kuali Foundation. All Rights Reserved.