Class PITGroup
java.lang.Object
edu.internet2.middleware.grouper.GrouperAPI
edu.internet2.middleware.grouper.pit.GrouperPIT
edu.internet2.middleware.grouper.pit.PITGroup
- All Implemented Interfaces:
HibGrouperLifecycle
,Hib3GrouperVersioned
,GrouperCloneable
,GrouperUtil.FieldValuable
,Serializable
,org.hibernate.classic.Lifecycle
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Context id links together multiple operations into one high level actionstatic final String
hibernate versionstatic final String
db id for this rowstatic final String
namestatic final String
columnstatic final String
columnstatic final String
stemstatic final String
constant for field name for: contextIdstatic final String
constant for field name for: idstatic final String
constant for field name for: namestatic final String
constant for field name for: sourceIdstatic final String
constant for field name for: sourceInternalIdstatic final String
constant for field name for: stemIdstatic final String
name of the table in the database.Fields inherited from class edu.internet2.middleware.grouper.pit.GrouperPIT
COLUMN_ACTIVE, COLUMN_END_TIME, COLUMN_START_TIME, FIELD_ACTIVE_DB, FIELD_END_TIME_DB, FIELD_START_TIME_DB
Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI
dbVersion, FIELD_DB_VERSION, FIELD_HIBERNATE_VERSION_NUMBER, INITIAL_VERSION_NUMBER
Fields inherited from interface org.hibernate.classic.Lifecycle
NO_VETO, VETO
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
deep clone the fields in this objectvoid
delete()
delete this objectboolean
getId()
getMembers
(String fieldSourceId, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Set<Source> sources, QueryOptions queryOptions) Get members of the group using point in time and the specified field.getName()
int
hashCode()
boolean
hasMember
(Subject subject, String fieldSourceId, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, QueryOptions queryOptions) Check if the group has a member using point in time and the specified field.void
onPreDelete
(HibernateSession hibernateSession) before a delete (insert) occursvoid
save or update this objectvoid
setContextId
(String contextId) set context idvoid
set idvoid
Set namevoid
setSourceId
(String sourceId) set source idvoid
setSourceInternalId
(Long sourceInternalId) void
Methods inherited from class edu.internet2.middleware.grouper.pit.GrouperPIT
getActiveDb, getEndTime, getEndTimeDb, getStartTime, getStartTimeDb, isActive, setActiveDb, setEndTimeDb, setStartTimeDb
Methods inherited from class edu.internet2.middleware.grouper.GrouperAPI
dbVersion, dbVersionClear, dbVersionDifferentFields, dbVersionIsDifferent, dbVersionReset, fieldValue, getHibernateVersionNumber, onDelete, onLoad, onPostDelete, onPostSave, onPostUpdate, onPreSave, onPreUpdate, onSave, onUpdate, setHibernateVersionNumber
-
Field Details
-
COLUMN_ID
db id for this row- See Also:
-
COLUMN_CONTEXT_ID
Context id links together multiple operations into one high level action- See Also:
-
COLUMN_NAME
name- See Also:
-
COLUMN_STEM_ID
stem- See Also:
-
COLUMN_HIBERNATE_VERSION_NUMBER
hibernate version- See Also:
-
COLUMN_SOURCE_ID
column- See Also:
-
COLUMN_SOURCE_INTERNAL_ID
column- See Also:
-
FIELD_SOURCE_ID
constant for field name for: sourceId- See Also:
-
FIELD_CONTEXT_ID
constant for field name for: contextId- See Also:
-
FIELD_ID
constant for field name for: id- See Also:
-
FIELD_NAME
constant for field name for: name- See Also:
-
FIELD_STEM_ID
constant for field name for: stemId- See Also:
-
FIELD_SOURCE_INTERNAL_ID
constant for field name for: sourceInternalId- See Also:
-
TABLE_GROUPER_PIT_GROUPS
name of the table in the database.- See Also:
-
-
Constructor Details
-
PITGroup
public PITGroup()
-
-
Method Details
-
getSourceInternalId
- Returns:
- sourceInternalId
-
setSourceInternalId
- Parameters:
sourceInternalId
-
-
getSourceId
- Returns:
- source id
-
setSourceId
set source id- Parameters:
sourceId
-
-
clone
Description copied from class:GrouperAPI
deep clone the fields in this object- Specified by:
clone
in interfaceGrouperCloneable
- Specified by:
clone
in classGrouperAPI
- Returns:
- the clone of the object
- See Also:
-
getContextId
- Returns:
- context id
-
setContextId
set context id- Parameters:
contextId
-
-
getId
- Returns:
- id
-
setId
set id- Parameters:
id
-
-
getName
- Returns:
- name
-
getNameDb
- Returns:
- name
-
setNameDb
Set name- Parameters:
name
-
-
getStemId
- Returns:
- stem id
-
setStemId
- Parameters:
stemId
-
-
saveOrUpdate
public void saveOrUpdate()save or update this object -
delete
public void delete()delete this object -
getMembers
public Set<Member> getMembers(String fieldSourceId, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Set<Source> sources, QueryOptions queryOptions) Get members of the group using point in time and the specified field. If the group currently exists, you must have read access to it. If it has been deleted, you must be wheel or root. You must also be wheel or root if the field has been deleted. An empty set is returned if you do not have appropriate privileges.- Parameters:
fieldSourceId
- specifies the field id. This is required.pointInTimeFrom
- the start of the range of the point in time query. This is optional.pointInTimeTo
- the end of the range of the point in time query. This is optional. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range.sources
- optionally filter on subject source ids.queryOptions
- optional query options.- Returns:
- set of pit members
-
hasMember
public boolean hasMember(Subject subject, String fieldSourceId, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, QueryOptions queryOptions) Check if the group has a member using point in time and the specified field.- Parameters:
subject
- specifies the subject. This is required.fieldSourceId
- specifies the field id. This is required.pointInTimeFrom
- the start of the range of the point in time query. This is optional.pointInTimeTo
- the end of the range of the point in time query. This is optional. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range.queryOptions
- optional query options.- Returns:
- boolean
-
equals
-
hashCode
public int hashCode() -
onPreDelete
Description copied from interface:HibGrouperLifecycle
before a delete (insert) occurs- Specified by:
onPreDelete
in interfaceHibGrouperLifecycle
- Overrides:
onPreDelete
in classGrouperAPI
- See Also:
-
getPITStem
- Returns:
- pitStem
-