org.kuali.rice.kim.api.role

Class RoleMembership.Builder

java.lang.Object

org.kuali.rice.kim.api.role.RoleMembership.Builder

All Implemented Interfaces:

Serializable, Identifiable, ModelBuilder, ModelObjectBasic, ModelObjectComplete, RoleMembershipContract

Enclosing class:

RoleMembership

public static final class RoleMembership.Builder
extends Object
implements ModelBuilder, RoleMembershipContract, ModelObjectComplete

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
RoleMembership	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static RoleMembership.Builder	create(RoleMembershipContract contract)
static RoleMembership.Builder	create(String roleId, String id, String memberId, MemberType memberType, Map<String,String> qualifier)
static RoleMembership.Builder	create(String roleId, String id, String memberId, MemberType memberType, Map<String,String> qualifier, org.joda.time.DateTime activeFromDate, org.joda.time.DateTime activeToDate)
boolean	equals(Object obj) All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.
org.joda.time.DateTime	getActiveFromDate()
org.joda.time.DateTime	getActiveToDate()
List<DelegateType.Builder>	getDelegates()
String	getEmbeddedRoleId()
String	getId() The unique identifier for an object.
String	getMemberId()
Map<String,String>	getQualifier()
String	getRoleId()
String	getRoleSortingCode()
MemberType	getType()
int	hashCode() All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
void	setActiveFromDate(org.joda.time.DateTime activeFromDate)
void	setActiveToDate(org.joda.time.DateTime activeToDate)
void	setDelegates(List<DelegateType.Builder> delegates)
void	setEmbeddedRoleId(String embeddedRoleId)
void	setId(String id)
void	setMemberId(String memberId)
void	setQualifier(Map<String,String> qualifier)
void	setRoleId(String roleId)
void	setRoleSortingCode(String roleSortingCode)
void	setType(MemberType type)
String	toString() This will return a proper string representation of the Model Object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static RoleMembership.Builder create(String roleId,
                            String id,
                            String memberId,
                            MemberType memberType,
                            Map<String,String> qualifier)

create

public static RoleMembership.Builder create(String roleId,
                            String id,
                            String memberId,
                            MemberType memberType,
                            Map<String,String> qualifier,
                            org.joda.time.DateTime activeFromDate,
                            org.joda.time.DateTime activeToDate)

create

public static RoleMembership.Builder create(RoleMembershipContract contract)

build

public RoleMembership 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

getRoleId

public String getRoleId()

Specified by:

getRoleId in interface RoleMembershipContract

setRoleId

public void setRoleId(String roleId)

getQualifier

public Map<String,String> getQualifier()

Specified by:

getQualifier in interface RoleMembershipContract

setQualifier

public void setQualifier(Map<String,String> qualifier)

getDelegates

public List<DelegateType.Builder> getDelegates()

Specified by:

getDelegates in interface RoleMembershipContract

setDelegates

public void setDelegates(List<DelegateType.Builder> delegates)

getActiveFromDate

public org.joda.time.DateTime getActiveFromDate()

setActiveFromDate

public void setActiveFromDate(org.joda.time.DateTime activeFromDate)

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

setActiveToDate

public void setActiveToDate(org.joda.time.DateTime activeToDate)

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)

getMemberId

public String getMemberId()

Specified by:

getMemberId in interface RoleMembershipContract

setMemberId

public void setMemberId(String memberId)

getType

public MemberType getType()

Specified by:

getType in interface RoleMembershipContract

setType

public void setType(MemberType type)

getEmbeddedRoleId

public String getEmbeddedRoleId()

Specified by:

getEmbeddedRoleId in interface RoleMembershipContract

Returns:

String Identifier of the role from which the group or principal was derived.

setEmbeddedRoleId

public void setEmbeddedRoleId(String embeddedRoleId)

getRoleSortingCode

public String getRoleSortingCode()

Specified by:

getRoleSortingCode in interface RoleMembershipContract

Returns:

String value used to sort the role members into a meaningful order

setRoleSortingCode

public void setRoleSortingCode(String roleSortingCode)

hashCode

public int hashCode()

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

Returns:

the hashCode value

equals

public boolean equals(Object obj)

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

Parameters:

obj - to object to compare for equality

Returns:

if equal

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object

Returns:

the string representation