org.kuali.rice.kim.impl.jaxb

Class PermissionDataXmlDTO

java.lang.Object

org.kuali.rice.kim.impl.jaxb.PermissionDataXmlDTO

public class PermissionDataXmlDTO
extends Object

This class represents the <permissionData> element.

The expected XML structure is as follows:

<permissionData>
<permissions>
<permission>
<permissionName namespaceCode=""></permissionName>
<templateName namespaceCode=""></templateName>
<description></description>
<active></active>
<permissionDetails>
<permissionDetail key=""></permissionDetail>
</permissionDetails>
</permission>
</permissions>
</permissionData>

Note the following:

• The <permissions> element is optional, and can contain zero or more <permission> elements.
• The <permissionName> element and its "namespaceCode" attribute are both required. The namespace code must map to a valid namespace. If the name and namespace combo matches an existing permission, then the permission in the XML will overwrite the existing permission.
• The <templateName> element and its "namespaceCode" attribute are both required. The name and namespace combo on this element must match a valid permission template.
• The <description> element is required, and must be non-blank.
• The <active> element is optional, and will be set to true if not specified.
• The <permissionDetails> element is optional, and can contain zero or more <permissionDetail> elements.
• The <permissionDetail> element's "key" attribute is required, and must be non-blank. Duplicate keys within a <permissionDetails> element are not permitted.
• The same permission can be ingested multiple times in the same file, where subsequent ones will overwrite previous ones. (TODO: Is this acceptable?)

TODO: Verify that the above behavior is correct.

Author:

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

Constructor Summary

Constructors

Constructor and Description
PermissionDataXmlDTO()
PermissionDataXmlDTO(PermissionsXmlDTO permissions)

Method Summary

Methods

Modifier and Type	Method and Description
PermissionsXmlDTO	getPermissions()
void	setPermissions(PermissionsXmlDTO permissions)

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionDataXmlDTO

public PermissionDataXmlDTO()

PermissionDataXmlDTO

public PermissionDataXmlDTO(PermissionsXmlDTO permissions)

Method Detail

getPermissions

public PermissionsXmlDTO getPermissions()

Returns:

the permissions

setPermissions

public void setPermissions(PermissionsXmlDTO permissions)

Parameters:

permissions - the permissions to set