Access (DDMSence 2.1.0 API)

Object
- buri.ddmsence.AbstractBaseComponent
- - buri.ddmsence.ddms.security.ntk.Access

All Implemented Interfaces:: IDDMSComponent

public final class Access
extends AbstractBaseComponent

An immutable implementation of ntk:Access.

Strictness
DDMSence allows the following legal, but nonsensical constructs: An Access element with no individual, group, or profile information can be used.

Strictness

DDMSence allows the following legal, but nonsensical constructs:

An Access element with no individual, group, or profile information can be used.

Nested Elements

Nested Elements
ntk:AccessIndividualList/ntk:AccessIndividual: A list system access info for individuals, implemented as a list of `Individual` ntk:AccessGroupList/ntk:AccessGroup: A list system access info for groups, implemented as a list of `Group` ntk:AccessProfileList: A list system access info for profiles, implemented as a `ProfileList` The list of profiles is a full-fledged object because the list might have security attributes. The other two lists are merely Java lists containing the real data.

ntk:AccessIndividualList/ntk:AccessIndividual: A list system access info for individuals, implemented as a list of Individual
ntk:AccessGroupList/ntk:AccessGroup: A list system access info for groups, implemented as a list of Group
ntk:AccessProfileList: A list system access info for profiles, implemented as a ProfileList
The list of profiles is a full-fledged object because the list might have security attributes. The other two lists are merely Java lists containing the real data.

Attributes
ntk:externalReference: A boolean attribute, true if this Access element describes an external resource (optional, starting in DDMS 4.1) `SecurityAttributes`: The classification and ownerProducer attributes are required.

Since:: 2.0.0
Author:: Brian Uri!

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Access.Builder
Builder for this DDMS component.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Access.Builder` Builder for this DDMS component.

Constructor Summary

Constructors
Constructor and Description
`Access(nu.xom.Element element)` Constructor for creating a component from a XOM Element
`Access(List<Individual> individuals, List<Group> groups, ProfileList profileList, Boolean externalReference, SecurityAttributes securityAttributes)` Constructor for creating a component from raw data
`Access(List<Individual> individuals, List<Group> groups, ProfileList profileList, SecurityAttributes securityAttributes)` Deprecated. A new constructor was added for DDMS 4.1 to support ntk:externalResource. This constructor is preserved for backwards compatibility, but may disappear in the next major release.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Test for logical equality.
`List<Group>`	`getGroups()` Accessor for the groups
`List<Individual>`	`getIndividuals()` Accessor for the individuals
`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.
`ProfileList`	`getProfileList()` Accessor for the profileList
`SecurityAttributes`	`getSecurityAttributes()` Accessor for the Security Attributes.
`Boolean`	`isExternalReference()` Accessor for the externalReference attribute.
`protected void`	`validate()` Validates the component.
`protected void`	`validateWarnings()` Validates any conditions that might result in a warning.

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

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Access
```
public Access(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
  - Access
```
public Access(List<Individual> individuals,
      List<Group> groups,
      ProfileList profileList,
      SecurityAttributes securityAttributes)
       throws InvalidDDMSException
```
    Deprecated. A new constructor was added for DDMS 4.1 to support ntk:externalResource. This constructor is preserved for backwards compatibility, but may disappear in the next major release.
    
    Constructor for creating a component from raw data
    
    Parameters:
    individuals - a list of individuals
    groups - a list of groups
    profileList - the profile list
    securityAttributes - security attributes (required)
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - Access
```
public Access(List<Individual> individuals,
      List<Group> groups,
      ProfileList profileList,
      Boolean externalReference,
      SecurityAttributes securityAttributes)
       throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    
    Parameters:
    individuals - a list of individuals
    groups - a list of groups
    profileList - the profile list
    externalReference - a boolean attribute (optional)
    securityAttributes - security attributes (required)
    
    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.
    
    A classification is required.
    
    At least 1 ownerProducer exists and is non-empty.
    
    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()
  - validateWarnings
```
protected void validateWarnings()
```
    Validates any conditions that might result in a warning.
    Rules
    
    No individuals, groups, or profiles are described in this Access element.
    
    An externalReference attribute may cause issues for DDMS 4.0 records.
    
    Overrides:
    
    validateWarnings in class AbstractBaseComponent
  - 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
  - getIndividuals
```
public List<Individual> getIndividuals()
```
    Accessor for the individuals
  - getGroups
```
public List<Group> getGroups()
```
    Accessor for the groups
  - getProfileList
```
public ProfileList getProfileList()
```
    Accessor for the profileList
  - isExternalReference
```
public Boolean isExternalReference()
```
    Accessor for the externalReference attribute. This may be null for Access elements before DDMS 4.1.
  - 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

Class Access

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

Access

Access

Access

Method Detail

validate

validateWarnings

getOutput

getNestedComponents

equals

getName

getIndividuals

getGroups

getProfileList

isExternalReference

getSecurityAttributes