org.sandev.TaskHeap.structs
Class HeapAssociationStruct

java.lang.Object
  org.sandev.TaskHeap.structs.HeapAssociationStruct

Direct Known Subclasses:

HeapAssociation

public class HeapAssociationStruct
extends java.lang.Object

An association allowing you access to a heap.

This message is persistent.
This message is a tree of values.
summary fields: uniqueID org.sandev.TaskHeap.util.DisplayUtil.heapAssocName(this,lookup,user)="name" heap.name="heap" access
This message has the following verb forms: update query collection
declared printname: Heap Association
help text: An association allowing you access to a heap.

Field Summary

protected int	access The access level granted.
protected long	account The account accessing the heap.
protected long	heap The heap being accessed.
protected java.lang.String	invitationEmail The email address used to invite this heap association.
protected java.lang.String	name The name from the account.
protected long[]	responsibilities The associated responsibilities.

Constructor Summary

HeapAssociationStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

heap

protected long heap

The heap being accessed.

reference to class: org.sandev.TaskHeap.structs.HeapAttributesStruct
help text: The heap being accessed.

account

protected long account

The account accessing the heap. This reference is null until the association is accepted by the invitee. The link sent in the email includes the target email address, so to accept an access invitation you need both the uniqueID of the HeapAssociation, and the email address it was sent to. That prevents randomly accepting IDs to try and get into a heap.

reference to class: org.sandev.TaskHeap.structs.AccountStruct
help text: The account accessing the heap.

invitationEmail

protected java.lang.String invitationEmail

The email address used to invite this heap association. When you accept a heap association, the account info is filled in. The invitation is retrieved using this email address.

declared invalid value: "TASKHEAP_INVALID_EMAIL"
Length in characters, normal: 50 max: 256
declared printname: invitation email
help text: The email address used to invite this heap association. When an account with this email address logs in, they will be able to accept the invitation.

name

protected transient java.lang.String name

The name from the account. Runtime field used for display and sorting operations.

Length in characters, normal: 40 max: 60
help text: The name from the account.

access

protected int access

The access level granted.

declared default value: NONE

enumerated constant values:

• NONE("None") = 0
  
• READER("Reader") = 1
  
• RESOURCE("Resource") = 5
  
• ADMIN("Admin") = 10
  

declared invalid value: -1
help text: The access level granted. None means no access to the heap at all. A reader may look at the heap contents but not update it. Resources may update the heap. An Admin is a resource that is additionally authorized for other administrative tasks such as setting up access for other account.

responsibilities

protected long[] responsibilities

The associated responsibilities.

reference to class: org.sandev.TaskHeap.structs.RoleStruct
help text: The associated responsibilities.

Constructor Detail

HeapAssociationStruct

public HeapAssociationStruct()