org.sandev.TaskHeap.structs
Class ReaderStruct

java.lang.Object
  org.sandev.basics.structs.BaseUserStruct
      org.sandev.TaskHeap.structs.ReaderStruct

Direct Known Subclasses:

Reader, ResourceStruct

public class ReaderStruct

extends org.sandev.basics.structs.BaseUserStruct

A Reader is a user who can read, but not modify, a TaskHeap. Readers are the base type for all TaskHeap users.

This message is persistent.
This message implements the AuthUser interface.
This message is a tree of values.
summary fields: username name email
This message has the following verb forms: update query collection history

Field Summary

protected java.lang.String	description Additional contact information, notes, and other information not captured in specific fields.
protected java.lang.String	email The email address for this user.
protected java.lang.String	name Full name of this user.
protected DisplayParamsStruct	userParams The DisplayParams this user is working with right now.
protected int	userStatus The access status for this user account.

Fields inherited from class org.sandev.basics.structs.BaseUserStruct

password, username

Constructor Summary

ReaderStruct()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Full name of this user.

declared invalid value: "TASKHEAP_INVALID_RESOURCENAME"
Length in characters, normal: 40 max: 80

description

protected java.lang.String description

Additional contact information, notes, and other information not captured in specific fields.

declared default value: ""
declared invalid value: "TASKHEAP_INVALID_DESCRIPTION"
Length in characters, normal: 255 max: 4096

email

protected java.lang.String email

The email address for this user. The email address is required as the primary method of contact. Multiple email addresses can be specified separated by commas, but if you forget your password you will have to specify the entire email text exactly as you entered it to retrieve your password.

declared invalid value: "TASKHEAP_INVALID_EMAIL"
Length in characters, normal: 50 max: 256

userStatus

protected int userStatus

The access status for this user account. By default all users are active. An inactive user may not access the TaskHeap, but their user information is still available to other Readers and Resources for reference.

declared default value: ACTIVE

enumerated constant values:

• _ACTIVE = 0
  
• _INACTIVE = 1
  

"is" boolean methods are generated for this field.
declared invalid value: -1
declared printname for field: user status

userParams

protected transient DisplayParamsStruct userParams

The DisplayParams this user is working with right now. This is a runtime only field used only by the UI to associate an object with its locally cached user instance.

Constructor Detail

ReaderStruct

public ReaderStruct()