edu.internet2.middleware.grouper.app.grouperTypes

Class GdgTypeGroupSave

java.lang.Object

edu.internet2.middleware.grouper.app.grouperTypes.GdgTypeGroupSave

public class GdgTypeGroupSave
extends Object

Use this class to add/edit/delete object types on groups

Sample call

 GdgTypeGroupSave gdgTypeGroupSave = new GdgTypeGroupSave();
 GrouperObjectTypesAttributeValue grouperObjectTypesAttributeValue = gdgTypeGroupSave
        .assignGroup(group)
        .assignType("ref")
        .assignDataOwner("do")
        .assignMemberDescription("md")
        .save();
 System.out.println(gdgTypeGroupSave.getSaveResultType()); // INSERT, DELETE, NO_CHANGE, or UPDATE
 

Sample call to delete an object type from a group

 GdgTypeGroupSave gdgTypeGroupSave = new GdgTypeGroupSave();
 gdgTypeGroupSave
        .assignGroup(group)
        .assignType("ref")
        .assignSaveMode(SaveMode.DELETE)
        .save();
 

Sample call to update only single attribute

 GdgTypeGroupSave gdgTypeGroupSave = new GdgTypeGroupSave();
 gdgTypeGroupSave
        .assignGroup(group)
        .assignType("ref")
        .assignReplaceAllSettings(false)
        .assignDataOwner("do1")
        .save();
 

Constructor Summary

Constructors

Constructor and Description
GdgTypeGroupSave()

Method Summary

Modifier and Type	Method and Description
GdgTypeGroupSave	assignDataOwner(String dataOwner) data owner to assign
GdgTypeGroupSave	assignGroup(Group group) group on which object types attributes need to be saved
GdgTypeGroupSave	assignGroupId(String groupId) group id on which object types attributes need to be saved
GdgTypeGroupSave	assignGroupName(String groupName) group name on which object types attributes need to be saved
GdgTypeGroupSave	assignMemberDescription(String memberDescription) member description to assign
GdgTypeGroupSave	assignReplaceAllSettings(boolean replaceAllSettings) replace all existing settings.
GdgTypeGroupSave	assignRunAsRoot(boolean runAsRoot) set this to true to run as a root session
GdgTypeGroupSave	assignSaveMode(SaveMode saveMode) assign save mode
GdgTypeGroupSave	assignServiceName(String serviceName) service name to assign
GdgTypeGroupSave	assignType(String type) type e.g.
SaveResultType	getSaveResultType() get save result type after the save call
GrouperObjectTypesAttributeValue	save() add/edit/delete object type attributes from a group

Methods inherited from class java.lang.Object

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

Constructor Detail

GdgTypeGroupSave

public GdgTypeGroupSave()

Method Detail

assignGroup

public GdgTypeGroupSave assignGroup(Group group)

group on which object types attributes need to be saved

Parameters:

group -

Returns:

assignGroupId

public GdgTypeGroupSave assignGroupId(String groupId)

group id on which object types attributes need to be saved

Parameters:

groupId -

Returns:

assignGroupName

public GdgTypeGroupSave assignGroupName(String groupName)

group name on which object types attributes need to be saved

Parameters:

groupName -

Returns:

assignType

public GdgTypeGroupSave assignType(String type)

type e.g. ref, basis, app

Parameters:

type -

Returns:

assignDataOwner

public GdgTypeGroupSave assignDataOwner(String dataOwner)

data owner to assign

Parameters:

dataOwner -

Returns:

assignMemberDescription

public GdgTypeGroupSave assignMemberDescription(String memberDescription)

member description to assign

Parameters:

memberDescription -

Returns:

assignServiceName

public GdgTypeGroupSave assignServiceName(String serviceName)

service name to assign

Parameters:

serviceName -

Returns:

assignRunAsRoot

public GdgTypeGroupSave assignRunAsRoot(boolean runAsRoot)

set this to true to run as a root session

Parameters:

runAsRoot -

Returns:

assignReplaceAllSettings

public GdgTypeGroupSave assignReplaceAllSettings(boolean replaceAllSettings)

replace all existing settings. defaults to true.

Parameters:

replaceAllSettings -

Returns:

assignSaveMode

public GdgTypeGroupSave assignSaveMode(SaveMode saveMode)

assign save mode

Parameters:

saveMode -

Returns:

getSaveResultType

public SaveResultType getSaveResultType()

get save result type after the save call

Returns:

save

public GrouperObjectTypesAttributeValue save()

add/edit/delete object type attributes from a group

Returns:

bean containing the current attribute values - can be null