Group

Name Group
Usage GroupService
getGroupsByPrincipalId getGroupsByPrincipalIdAndNamespaceCode getGroup getGroupByNamespaceCodeAndName getGroups createGroup updateGroup updateGroup
GroupQueryResults
Type Complex

Description

Copyright 2005-2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.opensource.org/licenses/ecl2.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Id String The unique identifier for an object. This can be null.     One No  
namespaceCode Namespace Code String This is the namespace code for the Group.


This is a namespace code assigned to a Group. Together with name, it makes up another unique identifier for Group

 Required   One No  
name Name String This is the name for the Group.


This is a name assigned to a Group. Together with NamespaceCode, it makes up another unique identifier for Group

 Required   One No  
description Description String This a description for the Group.


This is a description assigned to a Group.

     One No  
kimTypeId Kim Type Id String This a Kim Type Id for the Group.


This links a Kim Type to the Group to allow custom types of Groups.

 Required   One No  
attributes Attributes Map This is a set of Attributes for a Group.


This is a set of attributes which are key-label pairs that are defined by the Group's Kim Type.

     One No  
active Active boolean The active indicator for an object.     One No  
versionNumber Version Number Long 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.		     One No  
objectId Object Id String 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.		     One No