org.kuali.rice.kim.impl.jaxb
Class RolePermissionXmlDTO

java.lang.Object
  org.kuali.rice.kim.impl.jaxb.RolePermissionXmlDTO

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RolePermissionXmlDTO.OutsideOfRole, RolePermissionXmlDTO.WithinRole

public abstract class RolePermissionXmlDTO
extends Object
implements Serializable

Base class representing an unmarshalled <rolePermission> element. Refer to the static inner classes for more information about the specific contexts.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

static class	RolePermissionXmlDTO.OutsideOfRole This class represents a <rolePermission> element that is not a descendant of a <role> element.
static class	RolePermissionXmlDTO.WithinRole This class represents a <rolePermission> element that is a descendant of a <role> element.

Constructor Summary

RolePermissionXmlDTO()
Constructs an empty RolePermissionXmlDTO instance.

RolePermissionXmlDTO(org.kuali.rice.kim.api.permission.PermissionContract permission, boolean populateIds)
Constructs a RolePermissionXmlDTO that gets populated from the given KIM permission.

Method Summary

String	getPermissionId()
String	getPermissionName() Retrieves the permission name from the permission-name-and-namespace combo.
NameAndNamespacePair	getPermissionNameAndNamespace()
String	getPermissionNamespaceCode() Retrieves the permission namespace code from the permission-name-and-namespace combo.
abstract String	getRoleId() Retrieves the ID of the role that the permission is assigned to.
void	setPermissionId(String permissionId)
void	setPermissionNameAndNamespace(NameAndNamespacePair permissionNameAndNamespace)

Methods inherited from class java.lang.Object

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

Constructor Detail

RolePermissionXmlDTO

public RolePermissionXmlDTO()

Constructs an empty RolePermissionXmlDTO instance.

RolePermissionXmlDTO

public RolePermissionXmlDTO(org.kuali.rice.kim.api.permission.PermissionContract permission,
                            boolean populateIds)

Constructs a RolePermissionXmlDTO that gets populated from the given KIM permission.

Parameters:

permission - The permission that this DTO should obtain its data from.

populateIds - If true, the permission ID will get populated; otherwise, it will remain null.

Method Detail

getPermissionId

public String getPermissionId()

Returns:

the permissionId

setPermissionId

public void setPermissionId(String permissionId)

Parameters:

permissionId - the permissionId to set

getPermissionNameAndNamespace

public NameAndNamespacePair getPermissionNameAndNamespace()

Returns:

the permissionNameAndNamespace

setPermissionNameAndNamespace

public void setPermissionNameAndNamespace(NameAndNamespacePair permissionNameAndNamespace)

Parameters:

permissionNameAndNamespace - the permissionNameAndNamespace to set

getPermissionName

public String getPermissionName()

Retrieves the permission name from the permission-name-and-namespace combo.

Returns:

The name of the permission assigned to the role, or null if the permission-name-and-namespace combo is null.

getPermissionNamespaceCode

public String getPermissionNamespaceCode()

Retrieves the permission namespace code from the permission-name-and-namespace combo.

Returns:

The namespace code of the permission assigned to the role, or null if the permission-name-and-namespace combo is null.

getRoleId

public abstract String getRoleId()

Retrieves the ID of the role that the permission is assigned to. Subclasses are responsible for implementing this method so that it does so.

Returns:

The role ID of the role that the permission is assigned to.