Access (DDMSence 2.6.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.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

In JSON output, an extra layer is added around the individualList and groupList, to make the output consistent with the profileList.

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:AccessIndividualList/ntk:AccessIndividual

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:AccessGroupList/ntk:AccessGroup

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:AccessProfileList

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

ntk:externalReference

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:classification

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

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

This component can be used with no values set.

Warning

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:externalReference may cause issues for DDMS 4.0.1 systems.

Warning

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 Access.Builder
Builder for this DDMS component.

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

Field Summary
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Test for logical equality.
`List<Group>`	`getGroups()` Accessor for the groups
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`List<Individual>`	`getIndividuals()` Accessor for the individuals
`com.google.gson.JsonObject`	`getJSONObject()` An extra layer is added around the individualList and groupList, to make the output consistent with the profileList.
`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.
`ProfileList`	`getProfileList()` Accessor for the profileList
`SecurityAttributes`	`getSecurityAttributes()` Accessor for the Security Attributes.
`Boolean`	`isExternalReference()` Accessor for the externalReference attribute.
`protected void`	`validate()` Base case for validation.
`protected void`	`validateWarnings()` Base case for warnings.

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

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
    
    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
    
    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 AbstractBaseComponent
    
    Throws:
    
    InvalidDDMSException
    
    See Also:
    
    AbstractBaseComponent.validate()
  - validateWarnings
```
protected void validateWarnings()
```
    Description copied from class: AbstractBaseComponent
    
    Base case for warnings. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validateWarnings in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.validateWarnings()
  - getJSONObject
```
public com.google.gson.JsonObject getJSONObject()
```
    An extra layer is added around the individualList and groupList, to make the output consistent with the profileList.
    
    Specified by:
    
    getJSONObject in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.getJSONObject()
  - getHTMLTextOutput
```
public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as HTML or Text, with an optional prefix to nest it.
    I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.
    
    Specified by:
    
    getHTMLTextOutput in class AbstractBaseComponent
    
    Parameters:
    
    format - the desired format of this output
    
    prefix - an optional prefix to put on each name.
    
    suffix - an optional suffix to append to each name, such as an index.
    
    Returns:
    
    the representation of this component in the specified format
    
    See Also:
    
    AbstractBaseComponent.getHTMLTextOutput(OutputFormat, 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

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

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

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

getName

getIndividuals

getGroups

getProfileList

isExternalReference

getSecurityAttributes