buri.ddmsence.ddms.resource

Class ResourceManagement

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.resource.ResourceManagement

All Implemented Interfaces:

IDDMSComponent

public final class ResourceManagement
extends AbstractBaseComponent

An immutable implementation of ddms:resourceManagement.

Nested Elements

ddms:recordsManagementInfo: Information about the record keeper and software used to create the object to which this metadata applies (0-1 optional), implemented as a RecordsManagementInfo ddms:revisionRecall: Details about any revision recalls for this resource (0-1 optional), implemented as a RevisionRecall ddms:taskingInfo: Information about who requested production of the resource (0-many optional), implemented as a TaskingInfo ddms:processingInfo: Details about the processing of the resource (0-many optional), implemented as a ProcessingInfo

Attributes
SecurityAttributes: The classification and ownerProducer attributes are optional.

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceManagement.Builder Builder for this DDMS component.

Constructor Summary

Constructors

Constructor and Description
ResourceManagement(nu.xom.Element element) Constructor for creating a component from a XOM Element
ResourceManagement(RecordsManagementInfo recordsManagementInfo, RevisionRecall revisionRecall, List<TaskingInfo> taskingInfos, List<ProcessingInfo> processingInfos, SecurityAttributes securityAttributes) Constructor for creating a component from raw data

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
protected List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
List<ProcessingInfo>	getProcessingInfos() Accessor for the processing information
RecordsManagementInfo	getRecordsManagementInfo() Accessor for the recordsManagementInfo
RevisionRecall	getRevisionRecall() Accessor for the revisionRecall
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
List<TaskingInfo>	getTaskingInfos() Accessor for the tasking information
protected void	validate() Validates the component.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, hashCode, requireVersion, setXOMElement, toHTML, toString, toText, toXML, validateWarnings

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceManagement

public ResourceManagement(nu.xom.Element element)
                   throws InvalidDDMSException

Constructor for creating a component from a XOM Element

Parameters:

element - the XOM element representing this

Throws:

InvalidDDMSException - if any required information is missing or malformed

ResourceManagement

public ResourceManagement(RecordsManagementInfo recordsManagementInfo,
                  RevisionRecall revisionRecall,
                  List<TaskingInfo> taskingInfos,
                  List<ProcessingInfo> processingInfos,
                  SecurityAttributes securityAttributes)
                   throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

recordsManagementInfo - records management info (optional)

revisionRecall - information about revision recalls (optional)

taskingInfos - list of tasking info (optional)

processingInfos - list of processing info (optional)

securityAttributes - security attributes (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. Only 0-1 recordsManagementInfo or revisionRecall elements exist. This component cannot exist until DDMS 4.0.1 or later.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

getOutput

public String getOutput(boolean isHTML,
               String prefix,
               String suffix)

Description copied from class: AbstractBaseComponent

Renders this component as HTML or Text, with an optional prefix to nest it.

Specified by:

getOutput in class AbstractBaseComponent

Parameters:

isHTML - true for HTML, false for Text.

prefix - an optional prefix to put on each name.

suffix - an optional suffix to append to each name, such as an index.

Returns:

the HTML or Text representation of this component

See Also:

AbstractBaseComponent.getOutput(boolean, String, String)

getNestedComponents

protected List<IDDMSComponent> getNestedComponents()

Description copied from class: AbstractBaseComponent

Accessor for a collection of nested components. A list such as this is useful for bulk actions, such as checking emptiness, equality, generating hash codes, or applying mass validation.

Overrides:

getNestedComponents in class AbstractBaseComponent

See Also:

AbstractBaseComponent.getNestedComponents()

equals

public boolean equals(Object obj)

Description copied from class: AbstractBaseComponent

Test for logical equality.

The base case tests against the name value and namespaceURI, as well as any child components classified as "nested components" and any security attributes. Extending classes may require additional rules for equality. This case automatically includes any nested components or security attributes.

Overrides:

equals in class AbstractBaseComponent

See Also:

Object.equals(Object)

getName

public static String getName(DDMSVersion version)

Accessor for the element name of this component, based on the version of DDMS used

Parameters:

version - the DDMSVersion

Returns:

an element name

getRecordsManagementInfo

public RecordsManagementInfo getRecordsManagementInfo()

Accessor for the recordsManagementInfo

getRevisionRecall

public RevisionRecall getRevisionRecall()

Accessor for the revisionRecall

getTaskingInfos

public List<TaskingInfo> getTaskingInfos()

Accessor for the tasking information

getProcessingInfos

public List<ProcessingInfo> getProcessingInfos()

Accessor for the processing information

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null even if the attributes are not set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent