buri.ddmsence.ddms.security.ntk

Class Group

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractAccessEntity

buri.ddmsence.ddms.security.ntk.Group

All Implemented Interfaces:

IDDMSComponent

public final class Group
extends AbstractAccessEntity

An immutable implementation of ntk:AccessGroup.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
This class was introduced to support NTK components in DDMS 4.1. Those components are no longer a part of DDMS 5.0.

Nested Elements
Name Cardinality Availability ntk:AccessSystemName 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ntk:AccessGroupValue 1..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability ism:classification 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:ownerProducer 1..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:<securityAttributes> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules

Rule Type Applicability Component must not be used before the DDMS version in which it was introduced. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 The qualified name of this element must be correct. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ntk:AccessSystemName must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 At least 1 ntk:AccessGroupValue must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:classification must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:ownerProducer must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
Group(nu.xom.Element element) Constructor for creating a component from a XOM Element
Group(SystemName systemName, List<GroupValue> groupValues, SecurityAttributes securityAttributes) Constructor for creating a component from raw data

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
List<GroupValue>	getGroupValues() Accessor for the list of group values (1-many)
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.
protected String	getOutputName() Allows inheriting classes to provide a name for HTML/Text/JSON output.
protected List<?>	getOutputValues() Allows inheriting classes to provide the access values for HTML/Text/JSON output.
protected void	validate() Base case for validation.

Methods inherited from class buri.ddmsence.AbstractAccessEntity

getHTMLTextOutput, getJSONObject, getSecurityAttributes, getSystemName

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getValidationWarnings, getXOMElement, getXOMElementCopy, hashCode, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML, validateWarnings

Methods inherited from class Object

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

Constructor Detail

Group

public Group(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

Group

public Group(SystemName systemName,
             List<GroupValue> groupValues,
             SecurityAttributes securityAttributes)
      throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

systemName - the system name

groupValues - the list of values

securityAttributes - security attributes

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Description copied from class: AbstractBaseComponent

Base case for validation. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.

Overrides:

validate in class AbstractAccessEntity

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

getOutputName

protected String getOutputName()

Description copied from class: AbstractAccessEntity

Allows inheriting classes to provide a name for HTML/Text/JSON output.

Specified by:

getOutputName in class AbstractAccessEntity

See Also:

AbstractAccessEntity.getOutputName()

getOutputValues

protected List<?> getOutputValues()

Description copied from class: AbstractAccessEntity

Allows inheriting classes to provide the access values for HTML/Text/JSON output.

Specified by:

getOutputValues in class AbstractAccessEntity

See Also:

AbstractAccessEntity.getOutputValues()

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 AbstractAccessEntity

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 AbstractAccessEntity

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

getGroupValues

public List<GroupValue> getGroupValues()

Accessor for the list of group values (1-many)