GuiSubject (Grouper UI 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouper.grouperUi.beans.api.GuiObjectBase
- - edu.internet2.middleware.grouper.grouperUi.beans.api.GuiSubject

All Implemented Interfaces:

Serializable
```
public class GuiSubject
extends GuiObjectBase
implements Serializable
```
subject for gui has all attributes etc, and getter to be accessed from screen

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GuiSubject(Subject subject1)
construct with subject

Constructors
Constructor and Description
`GuiSubject(Subject subject1)` construct with subject

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`attributeValue(Subject subject, String attrName)`
`static Set<GuiSubject>`	`convertFromSubjects(Set<Subject> subjects)`
`static Set<GuiSubject>`	`convertFromSubjects(Set<Subject> subjects, String configMax, int defaultMax)`
`boolean`	`equals(Object other)`
`Map<String,String>`	`getAttributeLabel()` attribute label for this attribute if configured first get the text id for the source, then look in the externalized text for a label for the attribute, if not there, just use the attribute name
`Set<String>`	`getAttributeNamesExpandedView()` attribute names for this subject to show in the expanded view
`Set<String>`	`getAttributeNamesNonExpandedView()` attribute names for this subject to show in the non-expanded view
`Set<String>`	`getAttributeNamesNonInternal()` attribute names for this subject
`Map<String,String>`	`getAttributes()` Gets a map attribute names and value.
`String`	`getEmail()` get the email attribute value
`GrouperObject`	`getGrouperObject()` cant get grouper object
`Member`	`getMember()` get the member of the subject or null if not there
`String`	`getMemberId()` get the member id of the subject or null if not there
`String`	`getNameColonSpaceSeparated()` not applicable
`String`	`getPathColonSpaceSeparated()` path colon separated not applicable
`String`	`getScreenLabel()` get screen label
`String`	`getScreenLabelLong()` get screen label
`String`	`getScreenLabelLongIfDifferent()`
`String`	`getScreenLabelLongWithIcon()` long screen label with icon
`String`	`getScreenLabelShort2()` short screen label for ui v2
`String`	`getScreenLabelShort2noLink()` e.g.
`String`	`getScreenLabelShort2noLinkWithIcon()` e.g.
`String`	`getScreenSubjectIcon2Html()` span for subject-specific icon for ui v2; e.g.
`String`	`getShortLink()` e.g.
`String`	`getShortLinkWithIcon()` e.g.
`String`	`getSourceIdSubjectId()` return source id two pipes and subject id
`Subject`	`getSubject()` subject
`String`	`getTitle()` not applicable
`int`	`hashCode()`
`boolean`	`isGroup()` see if group or not
`boolean`	`isHasEmailAttributeInSource()` if the gui subject has an email address
`boolean`	`isLocalEntityDisabled()`
`boolean`	`isNeedsTooltip()` get short screen label
`boolean`	`isSubjectType()` if this is a subject
`static String`	`someSourceId()`

Methods inherited from class edu.internet2.middleware.grouper.grouperUi.beans.api.GuiObjectBase
convertFromGrouperObjects, getAdditionalBreadcrumbBullets, getBreadcrumbBullets, getBreadcrumbs, getCreatedString, getCreatorGuiSubject, getDateUiFormat, getLastEditedString, getLastUpdatedByGuiSubject, getParentGuiStem, getUserFriendlyTypesNames, isShowBreadcrumbLink, isShowBreadcrumbLinkSeparator, main, setAdditionalBreadcrumbBullets, setShowBreadcrumbLink, setShowBreadcrumbLinkSeparator, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GuiSubject
```
public GuiSubject(Subject subject1)
```
    construct with subject
    
    Parameters:
    
    subject1 -
- Method Detail
  - getSourceIdSubjectId
```
public String getSourceIdSubjectId()
```
    return source id two pipes and subject id
    
    Returns:
    
    the source id two pipes and subject id
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - getMemberId
```
public String getMemberId()
```
    get the member id of the subject or null if not there
    
    Returns:
    
    the member id if exists or null if not
  - getMember
```
public Member getMember()
```
    get the member of the subject or null if not there
    
    Returns:
    
    the member if exists or null if not
  - isHasEmailAttributeInSource
```
public boolean isHasEmailAttributeInSource()
```
    if the gui subject has an email address
    
    Returns:
    
    true if the subject has email
  - getEmail
```
public String getEmail()
```
    get the email attribute value
    
    Returns:
    
    the email or null or blank if not there
  - convertFromSubjects
```
public static Set<GuiSubject> convertFromSubjects(Set<Subject> subjects)
```
    Parameters:
    
    subjects -
    
    Returns:
    
    subjects
  - convertFromSubjects
```
public static Set<GuiSubject> convertFromSubjects(Set<Subject> subjects,
                                                  String configMax,
                                                  int defaultMax)
```
    Parameters:
    
    subjects -
    
    Returns:
    
    gui subjects
  - isGroup
```
public boolean isGroup()
```
    see if group or not
    
    Returns:
    
    if group
  - getShortLink
```
public String getShortLink()
```
    e.g. <a href="#">John Smith</a>
    
    Returns:
    
    short link
  - getShortLinkWithIcon
```
public String getShortLinkWithIcon()
```
    e.g. <a href="#">John Smith</a>
    
    Overrides:
    
    getShortLinkWithIcon in class GuiObjectBase
    
    Returns:
    
    short link
  - getScreenLabelShort2noLink
```
public String getScreenLabelShort2noLink()
```
    e.g. <a href="#">John Smith</a>
    
    Returns:
    
    short link
  - someSourceId
```
public static String someSourceId()
```
    Returns:
    
    a source id
  - getScreenLabelShort2
```
public String getScreenLabelShort2()
```
    short screen label for ui v2
    
    Returns:
    
    label
  - getScreenSubjectIcon2Html
```
public String getScreenSubjectIcon2Html()
```
    span for subject-specific icon for ui v2; e.g. '<i class="fa fa-group"></i> '
    
    Returns:
    
    label
  - getScreenLabel
```
public String getScreenLabel()
```
    get screen label
    
    Returns:
    
    screen label
  - getScreenLabelLong
```
public String getScreenLabelLong()
```
    get screen label
    
    Returns:
    
    screen label
  - getScreenLabelLongWithIcon
```
public String getScreenLabelLongWithIcon()
```
    long screen label with icon
    
    Returns:
    
    screen label
  - getSubject
```
public Subject getSubject()
```
    subject
    
    Returns:
    
    the subject
  - getAttributeNamesNonInternal
```
public Set<String> getAttributeNamesNonInternal()
```
    attribute names for this subject
    
    Returns:
    
    the attribute names for this subject
  - getAttributeNamesExpandedView
```
public Set<String> getAttributeNamesExpandedView()
```
    attribute names for this subject to show in the expanded view
    
    Returns:
    
    the attribute names for this subject
  - getAttributeNamesNonExpandedView
```
public Set<String> getAttributeNamesNonExpandedView()
```
    attribute names for this subject to show in the non-expanded view
    
    Returns:
    
    the attribute names for this subject
  - getAttributeLabel
```
public Map<String,String> getAttributeLabel()
```
    attribute label for this attribute if configured first get the text id for the source, then look in the externalized text for a label for the attribute, if not there, just use the attribute name
    
    Returns:
    
    the attribute label for this attribute
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Gets a map attribute names and value. The map's key contains the attribute name and the map's value contains a Set of attribute value(s). Note, this only does single valued attributes
    
    Returns:
    
    the map of attributes
  - getScreenLabelLongIfDifferent
```
public String getScreenLabelLongIfDifferent()
```
    Returns:
    
    long label if different than the short one
  - isNeedsTooltip
```
public boolean isNeedsTooltip()
```
    get short screen label
    
    Returns:
    
    short screen label
  - getScreenLabelShort2noLinkWithIcon
```
public String getScreenLabelShort2noLinkWithIcon()
```
    e.g. <a href="#">John Smith</a>
    
    Returns:
    
    short link
  - attributeValue
```
public static String attributeValue(Subject subject,
                                    String attrName)
```
    Parameters:
    
    subject -
    
    attrName -
    
    Returns:
    
    the value
  - getGrouperObject
```
public GrouperObject getGrouperObject()
```
    cant get grouper object
    
    Specified by:
    
    getGrouperObject in class GuiObjectBase
    
    Returns:
    
    the object
  - isSubjectType
```
public boolean isSubjectType()
```
    if this is a subject
    
    Overrides:
    
    isSubjectType in class GuiObjectBase
    
    Returns:
    
    if this is a subject
  - getPathColonSpaceSeparated
```
public String getPathColonSpaceSeparated()
```
    path colon separated not applicable
    
    Overrides:
    
    getPathColonSpaceSeparated in class GuiObjectBase
    
    Returns:
    
    the colon space separated path
  - getNameColonSpaceSeparated
```
public String getNameColonSpaceSeparated()
```
    not applicable
    
    Overrides:
    
    getNameColonSpaceSeparated in class GuiObjectBase
    
    Returns:
    
    the colon space separated path
  - getTitle
```
public String getTitle()
```
    not applicable
    
    Overrides:
    
    getTitle in class GuiObjectBase
    
    Returns:
    
    the title
  - isLocalEntityDisabled
```
public boolean isLocalEntityDisabled()
```
    Returns:
    
    true if this is a local entity that is disabled

Class GuiSubject

Constructor Summary

Method Summary

Methods inherited from class edu.internet2.middleware.grouper.grouperUi.beans.api.GuiObjectBase

Methods inherited from class java.lang.Object

Constructor Detail

GuiSubject

Method Detail

getSourceIdSubjectId

equals

hashCode

getMemberId

getMember

isHasEmailAttributeInSource

getEmail

convertFromSubjects

convertFromSubjects

isGroup

getShortLink

getShortLinkWithIcon

getScreenLabelShort2noLink

someSourceId

getScreenLabelShort2

getScreenSubjectIcon2Html

getScreenLabel

getScreenLabelLong

getScreenLabelLongWithIcon

getSubject

getAttributeNamesNonInternal

getAttributeNamesExpandedView

getAttributeNamesNonExpandedView

getAttributeLabel

getAttributes

getScreenLabelLongIfDifferent

isNeedsTooltip

getScreenLabelShort2noLinkWithIcon

attributeValue

getGrouperObject

isSubjectType

getPathColonSpaceSeparated

getNameColonSpaceSeparated

getTitle

isLocalEntityDisabled