kaos.core.service.directory
Interface DomainDescription

All Known Implementing Classes:

DefaultDomainDescription

public interface DomainDescription

Defines the operations to define and access information about a KAoS domain. The information includes the name of the domain begin described, the name of the parent domain and a collection containing the names of immediate children domains.

Field Summary

static java.lang.String	DOMAIN_CHILDREN_NAMES
static java.lang.String	DOMAIN_DEFAULT_MODALITY
static java.lang.String	DOMAIN_DEFAULT_PRIORITY
static java.lang.String	DOMAIN_MODALITY
static java.lang.String	DOMAIN_NAME
static java.lang.String	DOMAIN_PARENT_NAME
static java.lang.String	DOMAIN_PRIORITY

Method Summary

void	addChildName(java.lang.String name) Add a domain name to the collection of domain names that are immediate children of the domain described by this description.
java.util.List	getChildrenNames() Obtain the names of the immediate children domains.
java.lang.String	getDomainName() Obtain the name of the domain described by this description.
java.lang.String	getModality() Obtain the authorization modality of the domain described by this description.
java.lang.String	getParentName() Obtain the name of the parent domain.
java.lang.String	getPriority() Obtain the priority of the domain described by this description.
boolean	removeChildName(java.lang.String name) Remove a domain name from the collection of names of immediate children domains.
void	removeParentName(java.lang.String name) Remove the name of the parent of the domain described by this description.
void	setChildrenNames(java.util.List domainNames) Set the names of the immediate children domains.
void	setDomainName(java.lang.String name) Set the name of the domain described by this description.
void	setModality(java.lang.String modality) Set the authorization modality of the domain described by this description.
void	setParentName(java.lang.String name) Set the name of the parent of the domain described by this description.
void	setPriority(java.lang.String priority) Set the priority of the domain described by this description.

Field Detail

DOMAIN_CHILDREN_NAMES

static final java.lang.String DOMAIN_CHILDREN_NAMES

See Also:

Constant Field Values

DOMAIN_NAME

static final java.lang.String DOMAIN_NAME

See Also:

Constant Field Values

DOMAIN_MODALITY

static final java.lang.String DOMAIN_MODALITY

See Also:

Constant Field Values

DOMAIN_PRIORITY

static final java.lang.String DOMAIN_PRIORITY

See Also:

Constant Field Values

DOMAIN_PARENT_NAME

static final java.lang.String DOMAIN_PARENT_NAME

See Also:

Constant Field Values

DOMAIN_DEFAULT_MODALITY

static final java.lang.String DOMAIN_DEFAULT_MODALITY

DOMAIN_DEFAULT_PRIORITY

static final java.lang.String DOMAIN_DEFAULT_PRIORITY

See Also:

Constant Field Values

Method Detail

getChildrenNames

java.util.List getChildrenNames()

Obtain the names of the immediate children domains.

Returns:

List of domain names that are immediate children of domain that is described by this description.

setChildrenNames

void setChildrenNames(java.util.List domainNames)

Set the names of the immediate children domains.

Parameters:

domainNames - The domainNames containing a List of all names of domains that are immediate children of the domain described by this description.

addChildName

void addChildName(java.lang.String name)

Add a domain name to the collection of domain names that are immediate children of the domain described by this description.

Parameters:

name - The name of a domain to be added to the collection of children domain names.

removeChildName

boolean removeChildName(java.lang.String name)

Remove a domain name from the collection of names of immediate children domains.

Parameters:

name - The name of a domain to be removed from the collection of names of children domains.

Returns:

true if the collection of domain names contained the specified name; otherwise return false.

setDomainName

void setDomainName(java.lang.String name)

Set the name of the domain described by this description.

Parameters:

name - The name of the domain this description refers to.

getDomainName

java.lang.String getDomainName()

Obtain the name of the domain described by this description.

Returns:

String containing the name of the domain this description refers to.

setParentName

void setParentName(java.lang.String name)

Set the name of the parent of the domain described by this description.

Parameters:

name - The name of the parent domain.

removeParentName

void removeParentName(java.lang.String name)

Remove the name of the parent of the domain described by this description.

Parameters:

name - The name of the parent domain to be removed as a parent.

getModality

java.lang.String getModality()

Obtain the authorization modality of the domain described by this description.

Returns:

String containing the authorization modality of the domain this description refers to.

setModality

void setModality(java.lang.String modality)

Set the authorization modality of the domain described by this description.

Parameters:

modality - The modality of the domain described by this description.

getPriority

java.lang.String getPriority()

Obtain the priority of the domain described by this description.

Returns:

String containing the priority of the domain this description refers to.

setPriority

void setPriority(java.lang.String priority)

Set the priority of the domain described by this description.

Parameters:

priority - The priority of the domain described by this description.

getParentName

java.lang.String getParentName()

Obtain the name of the parent domain.

Returns:

String containing the name of the parent domain.