Package edu.internet2.middleware.grouper.app.externalSystem

Class GrouperExternalSystemUsage

java.lang.Object

edu.internet2.middleware.grouper.app.externalSystem.GrouperExternalSystemUsage

public class GrouperExternalSystemUsage
extends Object

One place in Grouper where an external system is referenced (used), either by config editor config (grouper_config) or by attribute data (loaders, reports). These are rendered as rows in the References section of the external system view details screen (Miscellaneous -> External systems -> Actions -> View details).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LINK_TYPE_GROUP	link kind: link to a group view page
static final String	LINK_TYPE_PROVISIONER	link kind constants.
static final String	LINK_TYPE_STEM	link kind: link to a folder (stem) view page

Constructor Summary

Constructors

Constructor	Description
GrouperExternalSystemUsage()	no-arg constructor
GrouperExternalSystemUsage(String usageType, String name, String description, String linkType)	convenience constructor

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getLinkType()
String	getName()
String	getUsageType()
void	setDescription(String description)
void	setLinkType(String linkType)
void	setName(String name)
void	setUsageType(String usageType)

Methods inherited from class java.lang.Object

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

Field Details

LINK_TYPE_PROVISIONER

public static final String LINK_TYPE_PROVISIONER

link kind constants. These decide whether/how the name is rendered as a link. A null linkType means no link (show the name as plain text) -- used for reference types that do not have their own view page.

See Also:

• Constant Field Values

LINK_TYPE_GROUP

public static final String LINK_TYPE_GROUP

link kind: link to a group view page

See Also:

• Constant Field Values

LINK_TYPE_STEM

public static final String LINK_TYPE_STEM

link kind: link to a folder (stem) view page

See Also:

• Constant Field Values

Constructor Details

GrouperExternalSystemUsage

public GrouperExternalSystemUsage()

no-arg constructor

GrouperExternalSystemUsage

public GrouperExternalSystemUsage(String usageType,
 String name,
 String description,
 String linkType)

convenience constructor

Parameters:

usageType - human readable type

name - display name of the referencing object

description - how the external system is used

linkType - one of LINK_TYPE_* or null for plain text

Method Details

getUsageType

public String getUsageType()

Returns:

human readable type of the reference

setUsageType

public void setUsageType(String usageType)

Parameters:

usageType - human readable type of the reference

getName

public String getName()

Returns:

display name of the referencing object

setName

public void setName(String name)

Parameters:

name - display name of the referencing object

getDescription

public String getDescription()

Returns:

how the external system is used

setDescription

public void setDescription(String description)

Parameters:

description - how the external system is used

getLinkType

public String getLinkType()

Returns:

one of LINK_TYPE_* or null for plain text

setLinkType

public void setLinkType(String linkType)

Parameters:

linkType - one of LINK_TYPE_* or null for plain text