Package edu.internet2.middleware.grouper.attr.assign

Class AttributeAssignToStemSave

java.lang.Object

edu.internet2.middleware.grouper.attr.assign.AttributeAssignToStemSave

public class AttributeAssignToStemSave
extends Object

Use this class to add/edit/delete attribute def names on folders.

Sample call

 import edu.internet2.middleware.grouper.attr.assign.*;
 AttributeAssignToStemSave attributeAssignToStemSave = new AttributeAssignToStemSave().assignAttributeDefName(attributeDefName).assignStem(stem);
 AttributeAssign attributeAssign = attributeAssignToStemSave.save();
 System.out.println(attributeAssignToStemSave.getSaveResultType()); // DELETE, INSERT, NO_CHANGE, or UPDATE
 

Sample call to remove attribute def name from a folder

 import edu.internet2.middleware.grouper.attr.assign.*;
 new AttributeAssignToStemSave().assignAttributeDefName(attributeDefName).assignStem(stem).assignSaveMode(SaveMode.DELETE).save();
 

Sample call to assign attribute and metadata with values. Note, this example doesnt make sense since this attribute is assignable to groups, but this is how to do it.

  import edu.internet2.middleware.grouper.attr.assign.*;
  AttributeAssign attributeAssign = new AttributeAssignToStemSave().
    assignNameOfAttributeDefName("etc:attribute:abacJexlScript:grouperJexlScriptMarker").
    assignStemName("test:isc:astt:chris:testJexl2").save();
  
  attributeAssign.getAttributeValueDelegate().assignValueString(
    "etc:attribute:abacJexlScript:grouperJexlScriptJexlScript", 
    "${entity.memberOf('test:testGroup') && !entity.memberOf('test:testGroup1')}");
 

Constructor Summary

Constructors

Constructor	Description
AttributeAssignToStemSave()

Method Summary

Modifier and Type	Method	Description
AttributeAssignToStemSave	assignAttributeDefName(AttributeDefName theAttributeDefName)	attribute def name to add/update/delete from folder
AttributeAssignToStemSave	assignNameOfAttributeDefName(String theNameOfAttributeDefName)	attribute def name to add/update/delete from folder
AttributeAssignToStemSave	assignRunAsRoot(boolean runAsRoot)	set this to true to run as a root session
AttributeAssignToStemSave	assignSaveMode(SaveMode theSaveMode)	assign save mode
AttributeAssignToStemSave	assignStem(Stem theStem)	assign a stem
AttributeAssignToStemSave	assignStemId(String theStemId)	stem id to add to, mutually exclusive with stem name and stem
AttributeAssignToStemSave	assignStemName(String theStemName)	stem name to add to, mutually exclusive with stem id and stem
SaveResultType	getSaveResultType()	get the save result type after the save call
static void	main(String[] args)
AttributeAssign	save()	add, edit or delete an attribute def name from folder

Methods inherited from class java.lang.Object

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

Constructor Details

AttributeAssignToStemSave

public AttributeAssignToStemSave()

Method Details

assignRunAsRoot

public AttributeAssignToStemSave assignRunAsRoot(boolean runAsRoot)

set this to true to run as a root session

Parameters:

runAsRoot -

Returns:

main

public static void main(String[] args)

Parameters:

args -

assignAttributeDefName

public AttributeAssignToStemSave assignAttributeDefName(AttributeDefName theAttributeDefName)

attribute def name to add/update/delete from folder

Parameters:

theAttributeDefName -

Returns:

this for chaining

assignNameOfAttributeDefName

public AttributeAssignToStemSave assignNameOfAttributeDefName(String theNameOfAttributeDefName)

attribute def name to add/update/delete from folder

Parameters:

theNameOfAttributeDefName -

Returns:

assignStem

public AttributeAssignToStemSave assignStem(Stem theStem)

assign a stem

Parameters:

theStem -

Returns:

this for chaining

assignStemId

public AttributeAssignToStemSave assignStemId(String theStemId)

stem id to add to, mutually exclusive with stem name and stem

Parameters:

theStemId -

Returns:

this for chaining

assignStemName

public AttributeAssignToStemSave assignStemName(String theStemName)

stem name to add to, mutually exclusive with stem id and stem

Parameters:

theStemName -

Returns:

this for chaining

assignSaveMode

public AttributeAssignToStemSave assignSaveMode(SaveMode theSaveMode)

assign save mode

Parameters:

theSaveMode -

Returns:

this for chaining

getSaveResultType

public SaveResultType getSaveResultType()

get the save result type after the save call

Returns:

save type

save

public AttributeAssign save()
                     throws InsufficientPrivilegeException,
GroupNotFoundException

 add, edit or delete an attribute def name from folder
 

Returns:

the attribute assign that was updated or created or deleted

Throws:

InsufficientPrivilegeException

GroupNotFoundException