edu.internet2.middleware.grouper.app.gsh
Class XmlExport

java.lang.Object
  edu.internet2.middleware.grouper.app.gsh.XmlExport

public class XmlExport
extends java.lang.Object

chaining object to export the registry

Constructor Summary

XmlExport()

Method Summary

XmlExport	childrenOnly(boolean isChildrenOnly) for export of a stem if we should only export the children and not the stem itself
XmlExport	collectionMessage(java.lang.String theMessage) assign a collection message for a groups and strings export
void	exportToFile(java.io.File file) export to string
java.lang.String	exportToString() export to string
XmlExport	group(Group theGroup) export a group, and chain
XmlExport	grouperSession(GrouperSession theGrouperSession) assign the grouper session to this exporter
XmlExport	groupsAndStems(java.util.Collection theGroupsAndStems) export this collection of groups and stems
XmlExport	groupsAndStems(java.lang.Object[] theGroupsAndStems) export this collection of groups and stems
XmlExport	includeParent(boolean isIncludeParent) for export of groups if we should include parent
XmlExport	relative(boolean isRelative) set that this group or stem export is relative
XmlExport	stem(Stem theStem) export a stem and chain
XmlExport	userProperties(java.io.File theUserProperties) set external properties file

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlExport

public XmlExport()

Method Detail

grouperSession

public XmlExport grouperSession(GrouperSession theGrouperSession)

assign the grouper session to this exporter

Parameters:

theGrouperSession -

Returns:

this for chaining

stem

public XmlExport stem(Stem theStem)

export a stem and chain

Parameters:

theStem -

Returns:

this object for chaining

group

public XmlExport group(Group theGroup)

export a group, and chain

Parameters:

theGroup -

Returns:

this object for chaining

collectionMessage

public XmlExport collectionMessage(java.lang.String theMessage)

assign a collection message for a groups and strings export

Parameters:

theMessage -

Returns:

the collection message

groupsAndStems

public XmlExport groupsAndStems(java.util.Collection theGroupsAndStems)

export this collection of groups and stems

Parameters:

theGroupsAndStems -

Returns:

the collection

groupsAndStems

public XmlExport groupsAndStems(java.lang.Object[] theGroupsAndStems)

export this collection of groups and stems

Parameters:

theGroupsAndStems -

Returns:

the collection

relative

public XmlExport relative(boolean isRelative)

set that this group or stem export is relative

Parameters:

isRelative -

Returns:

this for chaining

includeParent

public XmlExport includeParent(boolean isIncludeParent)

for export of groups if we should include parent

Parameters:

isIncludeParent -

Returns:

if we should include parent

childrenOnly

public XmlExport childrenOnly(boolean isChildrenOnly)

for export of a stem if we should only export the children and not the stem itself

Parameters:

isChildrenOnly -

Returns:

if we should only export children

userProperties

public XmlExport userProperties(java.io.File theUserProperties)

set external properties file

Parameters:

theUserProperties -

Returns:

the properties file

exportToString

public java.lang.String exportToString()

export to string

Returns:

the string of xml

exportToFile

public void exportToFile(java.io.File file)

export to string

Parameters:

file -