org.kuali.rice.kim.api.permission

Class Permission.Builder

java.lang.Object

org.kuali.rice.kim.api.permission.Permission.Builder

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelBuilder, PermissionContract

Enclosing class:

Permission

public static final class Permission.Builder
extends Object
implements PermissionContract, ModelBuilder, Serializable

This builder constructs a Permission enforcing the constraints of the PermissionContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
Permission	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static Permission.Builder	create(PermissionContract contract) Creates a Permission from an existing PermissionContract.
static Permission.Builder	create(String namespaceCode, String name) Creates a Permission with the required fields.
Map<String,String>	getAttributes() Attributes for a Permission.
String	getDescription() The description of the Permission.
String	getId() The unique identifier for an object.
String	getName() The name of the Permission.
String	getNamespaceCode() The namespace code that this Permission belongs too.
String	getObjectId() Return the globally unique object id of this object.
Template.Builder	getTemplate() The Template referenced by the Permission.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
void	setActive(boolean active)
void	setAttributes(Map<String,String> attributes)
void	setDescription(String description)
void	setId(String id)
void	setName(String name)
void	setNamespaceCode(String namespaceCode)
void	setObjectId(String objectId)
void	setTemplate(Template.Builder template)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Permission.Builder create(String namespaceCode,
                        String name)

Creates a Permission with the required fields.

create

public static Permission.Builder create(PermissionContract contract)

Creates a Permission from an existing PermissionContract.

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

setId

public void setId(String id)

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: PermissionContract

The namespace code that this Permission belongs too.

Specified by:

getNamespaceCode in interface PermissionContract

Returns:

namespaceCode

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

getName

public String getName()

Description copied from interface: PermissionContract

The name of the Permission.

Specified by:

getName in interface PermissionContract

Returns:

name

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: PermissionContract

The description of the Permission.

Specified by:

getDescription in interface PermissionContract

Returns:

description

setDescription

public void setDescription(String description)

getTemplate

public Template.Builder getTemplate()

Description copied from interface: PermissionContract

The Template referenced by the Permission.

Specified by:

getTemplate in interface PermissionContract

Returns:

templateId

setTemplate

public void setTemplate(Template.Builder template)

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

setActive

public void setActive(boolean active)

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

setVersionNumber

public void setVersionNumber(Long versionNumber)

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet

setObjectId

public void setObjectId(String objectId)

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: PermissionContract

Attributes for a Permission.

Specified by:

getAttributes in interface PermissionContract

Returns:

attributes

setAttributes

public void setAttributes(Map<String,String> attributes)

build

public Permission build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null