org.apache.jetspeed.security
Interface JetspeedPrincipalAssociationType

All Superinterfaces:

java.io.Serializable

public interface JetspeedPrincipalAssociationType
extends java.io.Serializable

Version:

$Id$

Field Summary

static java.lang.String	BELONGS_TO build-in supported @{link associationName "belongsTo"
static java.lang.String	IS_A build-in supported @{link associationName "isA"
static java.lang.String	IS_CHILD_OF build-in supported @{link associationName "isChildOf"
static java.lang.String	IS_MEMBER_OF build-in supported @{link associationName "isMemberOf"
static java.lang.String	IS_PART_OF build-in supported @{link associationName "isPartOf"

Method Summary

java.lang.String	getAssociationName() The name which is used together with the getFromPrincipalType() and the getToPrincipalType() to identify a specific association between two JetspeedPrincipals.
JetspeedPrincipalType	getFromPrincipalType()
JetspeedPrincipalType	getToPrincipalType()
boolean	isDependent() True if the from principal will be deleted when the to principal is deleted.
boolean	isDominant() True if the to principal can be associated to at most once.
boolean	isMixedTypes() True if this is an association between two different JetspeedPrincipalTypes
boolean	isRequired() True if the from principal cannot be created without this association.
boolean	isSingular() True if the from principal can be associated at most once.

Field Detail

IS_MEMBER_OF

static final java.lang.String IS_MEMBER_OF

build-in supported @{link associationName "isMemberOf"

This association type between two different JetspeedPrincipalTypes represents an N to M relationship

Configuration needed for this association type:

• required : false
• dependent: false
• singular : false
• dominant : false

See Also:

Constant Field Values

IS_CHILD_OF

static final java.lang.String IS_CHILD_OF

build-in supported @{link associationName "isChildOf"

This association type between two equal JetspeedPrincipalTypes represents a required from child to parent hierarchical relationship.

Configuration needed for this association type:

• required : true
• dependent: true
• singular : true
• dominant : false

See Also:

Constant Field Values

IS_A

static final java.lang.String IS_A

build-in supported @{link associationName "isA"

This association type between two equal JetspeedPrincipalTypes represents a Generalizing Hierarchical relationship where from implies to.

Configuration needed for this association type:

• required : false
• dependent: true
• singular : true
• dominant : false

See Also:

Constant Field Values

IS_PART_OF

static final java.lang.String IS_PART_OF

build-in supported @{link associationName "isPartOf"

This association type between two equal JetspeedPrincipalTypes represents a Aggregating Hierarchical relationship where to implies from.

Configuration needed for this association type (same as IS_MEMBER_OF):

• required : false
• dependent: false
• singular : false
• dominant : false

See Also:

Constant Field Values

BELONGS_TO

static final java.lang.String BELONGS_TO

build-in supported @{link associationName "belongsTo"

This association type betweem two different JetspeedPrincipalTypes represents a required relationship where from may only belong to one to

Configuration needed for this association type:

• required : true
• dependent: true
• singular : true
• dominant : false

See Also:

Constant Field Values

Method Detail

getAssociationName

java.lang.String getAssociationName()

The name which is used together with the getFromPrincipalType() and the getToPrincipalType() to identify a specific association between two JetspeedPrincipals.

Note: the asociation name value must conform to the Java Identifier requirements (e.g. no spaces, dots, etc.) to support localization through resource bundles.

getFromPrincipalType

JetspeedPrincipalType getFromPrincipalType()

getToPrincipalType

JetspeedPrincipalType getToPrincipalType()

isRequired

boolean isRequired()

True if the from principal cannot be created without this association.

If isDependent() the from principal will be deleted when the to principal is deleted, otherwise deleting the to principal is not allowed without first transfering association to another.

isDependent

boolean isDependent()

True if the from principal will be deleted when the to principal is deleted.

Deleting the to principal is not allowed when isRequired() until the association is transferred to another.

isSingular

boolean isSingular()

True if the from principal can be associated at most once.

isDominant

boolean isDominant()

True if the to principal can be associated to at most once.

isMixedTypes

boolean isMixedTypes()

True if this is an association between two different JetspeedPrincipalTypes

Returns: