All Superinterfaces:

Readable, Root, SchedulerEntity, SchedulerEntityComp
```
public interface AuditSubjectLogin
extends Root, Readable
```

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`OBJECT_TYPE`	String that will be returned from `SchedulerEntity.getObjectType()` for "AuditSubjectLogin" objects.
`static String`	`SEC_PRIV_CREATE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_DELETE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_EDIT`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_VIEW`	This privilege can be granted at a group level.
`static String`	`SEC_RANK_ALL`	This rank is made of the following privileges: view , create , edit , delete
`static String`	`SEC_RANK_CREATE`	This rank is made of the following privileges: create
`static String`	`SEC_RANK_DELETE`	This rank is made of the following privileges: create , view , delete
`static String`	`SEC_RANK_EDIT`	This rank is made of the following privileges: create , view , edit
`static String`	`SEC_RANK_NONE`	This rank has no privileges assigned to it.
`static String`	`SEC_RANK_VIEW`	This rank is made of the following privileges: view
`static QueryObjectType<AuditSubjectLogin>`	`TYPE`	Type that can be used in `SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)`.

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity
ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RequiredPermission`	`checkCreatePrivilege()`	Check whether or not the create action can be performed on this object.
`RequiredPermission`	`checkDeletePrivilege()`	Check whether or not the delete action can be performed on this object.
`RequiredPermission`	`checkEditPrivilege()`	Check whether or not the edit action can be performed on this object.
`RequiredPermission`	`checkViewPrivilege()`	Check whether or not the view action can be performed on this object.
`String`	`getChannel()`	Get the value for Channel.
`String`	`getForwarded()`	Get the value for Forwarded.
`String`	`getForwardedFor()`	Get the value for ForwardedFor.
`String`	`getIPAddress()`	Get the value for IPAddress.
`DateTimeZone`	`getLoginDateTime()`	Get the value for LoginDateTime.
`DateTimeZone`	`getLogoutDateTime()`	Get the value for LogoutDateTime.
`String`	`getProtocol()`	Get the value for Protocol.
`String`	`getReason()`	Get the value for Reason.
`String`	`getSearchUser()`	Get the value for SearchUser.
`String`	`getUser()`	Get the value for User.
`String`	`getUserAgent()`	Get the value for UserAgent.
`boolean`	`isSuccessful()`	Get the value for Successful.

Methods inherited from interface com.redwood.scheduler.api.model.Root
getCreationTime, getLastModificationTime, getLastModifierSubject

- Field Detail
  - OBJECT_TYPE
```
static final String OBJECT_TYPE
```
    String that will be returned from SchedulerEntity.getObjectType() for "AuditSubjectLogin" objects.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
static final QueryObjectType<AuditSubjectLogin> TYPE
```
    Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
  - SEC_PRIV_VIEW
```
static final String SEC_PRIV_VIEW
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_CREATE
```
static final String SEC_PRIV_CREATE
```
    This privilege can be granted at a group level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_EDIT
```
static final String SEC_PRIV_EDIT
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_DELETE
```
static final String SEC_PRIV_DELETE
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_NONE
```
static final String SEC_RANK_NONE
```
    This rank has no privileges assigned to it.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_CREATE
```
static final String SEC_RANK_CREATE
```
    This rank is made of the following privileges: create
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_VIEW
```
static final String SEC_RANK_VIEW
```
    This rank is made of the following privileges: view
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_EDIT
```
static final String SEC_RANK_EDIT
```
    This rank is made of the following privileges: create , view , edit
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_DELETE
```
static final String SEC_RANK_DELETE
```
    This rank is made of the following privileges: create , view , delete
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_ALL
```
static final String SEC_RANK_ALL
```
    This rank is made of the following privileges: view , create , edit , delete
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getUser
```
String getUser()
```
    Get the value for User. (The user.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getSearchUser
```
String getSearchUser()
```
    Get the value for SearchUser. (The search form of the user.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getLoginDateTime
```
DateTimeZone getLoginDateTime()
```
    Get the value for LoginDateTime. (The time at which the user logged in.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getLogoutDateTime
```
DateTimeZone getLogoutDateTime()
```
    Get the value for LogoutDateTime. (The time at which the user logged out.)
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getChannel
```
String getChannel()
```
    Get the value for Channel. () This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getUserAgent
```
String getUserAgent()
```
    Get the value for UserAgent. () This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getIPAddress
```
String getIPAddress()
```
    Get the value for IPAddress. (Contains the IP Address where the request came from) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getProtocol
```
String getProtocol()
```
    Get the value for Protocol. () This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - isSuccessful
```
boolean isSuccessful()
```
    Get the value for Successful. (Indicates whether the login was successful or not.)
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getReason
```
String getReason()
```
    Get the value for Reason. (Contains the reason (for now this is the reason why the login attempt failed, if 'Successful' is false).)
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getForwardedFor
```
String getForwardedFor()
```
    Get the value for ForwardedFor. (Contains the value from the X-Forwarded-For header)
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getForwarded
```
String getForwarded()
```
    Get the value for Forwarded. (Contains the value from the Forwarded header)
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - checkViewPrivilege
```
RequiredPermission checkViewPrivilege()
```
    Check whether or not the view action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkCreatePrivilege
```
RequiredPermission checkCreatePrivilege()
```
    Check whether or not the create action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkEditPrivilege
```
RequiredPermission checkEditPrivilege()
```
    Check whether or not the edit action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkDeletePrivilege
```
RequiredPermission checkDeletePrivilege()
```
    Check whether or not the delete action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

Interface AuditSubjectLogin

Field Summary

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

Method Summary

Methods inherited from interface com.redwood.scheduler.api.model.Root

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

Field Detail

OBJECT_TYPE

TYPE

SEC_PRIV_VIEW

SEC_PRIV_CREATE

SEC_PRIV_EDIT

SEC_PRIV_DELETE

SEC_RANK_NONE

SEC_RANK_CREATE

SEC_RANK_VIEW

SEC_RANK_EDIT

SEC_RANK_DELETE

SEC_RANK_ALL

Method Detail

getUser

getSearchUser

getLoginDateTime

getLogoutDateTime

getChannel

getUserAgent

getIPAddress

getProtocol

isSuccessful

getReason

getForwardedFor

getForwarded

checkViewPrivilege

checkCreatePrivilege

checkEditPrivilege

checkDeletePrivilege