org.kuali.student.r1.lum.lu.dto
Class CluPublicationInfo

java.lang.Object
  org.kuali.student.r1.lum.lu.dto.CluPublicationInfo

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

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

Detailed information about publishing a clu.

See Also:

Serialized Form

Constructor Summary

CluPublicationInfo()

Method Summary

Map<String,String>	getAttributes() List of key/value pairs, typically used for dynamic attributes.
String	getCluId() The identifier for the canonical learning unit which is described by this publication information.
Date	getEffectiveDate() Date and time that this LU publication type became effective.
String	getEndCycle() The end academic time period for when the CLU should be published in this type of usage.
Date	getExpirationDate() Date and time that this LU publication type expires.
String	getId() Identifier for the publishing information.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getStartCycle() The start academic time period for when the CLU should be published in this type of usage.
String	getState() Current state of the information for this publication type.
String	getType() Type of publication for which this information should be used.
List<FieldInfo>	getVariants() Fields in cluInfo whose values are overridden as part of this publication.
void	setAttributes(Map<String,String> attributes)
void	setCluId(String cluId)
void	setEffectiveDate(Date effectiveDate)
void	setEndCycle(String endCycle)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setMetaInfo(MetaInfo metaInfo)
void	setStartCycle(String startCycle)
void	setState(String state)
void	setType(String type)
void	setVariants(List<FieldInfo> variants)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CluPublicationInfo

public CluPublicationInfo()

Method Detail

getCluId

public String getCluId()

The identifier for the canonical learning unit which is described by this publication information.

setCluId

public void setCluId(String cluId)

getVariants

public List<FieldInfo> getVariants()

Fields in cluInfo whose values are overridden as part of this publication.

setVariants

public void setVariants(List<FieldInfo> variants)

getStartCycle

public String getStartCycle()

The start academic time period for when the CLU should be published in this type of usage. Should be less than or equal to endCycle.

setStartCycle

public void setStartCycle(String startCycle)

getEndCycle

public String getEndCycle()

The end academic time period for when the CLU should be published in this type of usage. If specified, should be greater than or equal to startCycle.

setEndCycle

public void setEndCycle(String endCycle)

getEffectiveDate

public Date getEffectiveDate()

Date and time that this LU publication type 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 LU publication type 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()

Type of publication for which this information should be used.

Specified by:

getType in interface HasTypeState

setType

public void setType(String type)

Specified by:

setType in interface HasTypeState

getState

public String getState()

Current state of the information for this publication type. This value should be constrained to those within the cluPublishingState enumeration. In general, an "active" record for a type indicates that the clu should be published within that media, though that may be further constrained by the cycle information included.

Specified by:

getState in interface HasTypeState

setState

public void setState(String state)

Specified by:

setState in interface HasTypeState

getId

public String getId()

Identifier for the publishing information. This is set by the service to be able to determine changes and alterations to the structure as well as provides a handle for searches. This structure is not currently accessible through unique operations, and it is strongly recommended that no external references to this particular identifier be maintained.

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