com.neurosys.domain

Interface IHierarchialReference<I>

Type Parameters:

I - as Id type

All Known Subinterfaces:

AreaType, IProductReference, IProductReference

All Known Implementing Classes:

AbstractArea, AbstractContent, AbstractReference, ActivityRef, AffiliateRef, Area, CartItem, Comment, ContentDescriber, CustomAutoNav.CustomHierarchicalReference, DataRef, DesignationRef, GenericObject, HierarchialDomainObject, HierarchialDomainObjectWithAttributes, Organization, OrganizationRef, PersonOrgRef, PersonRef, PlaceRef, PointRef, Post, Product, Product, ProductReference, ProductReference, Reference, Region, SubOrder, ThingRef

public interface IHierarchialReference<I>

An instance that can act as a reference to some Hierarchial item. The implementing item may or may not be part of the Hierarchy.

Author:

Arjun Dhar

See Also:

HierarchialDomainObject

Field Summary

Fields

Modifier and Type	Field and Description
static Long	ROOT In some situations null is hard to figure if it represents NONE or Root (since Root does not have an Id); providing a constant to refer to its intention.

Method Summary

Modifier and Type	Method and Description
String	getHierarchy() A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
I	getId()
String	getName() Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.
I	getParentId()
void	setHierarchy(String hierarchy) A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
void	setId(I id)
void	setName(String name) Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.
void	setParentId(I parentId)

Field Detail

ROOT

static final Long ROOT

In some situations null is hard to figure if it represents NONE or Root (since Root does not have an Id); providing a constant to refer to its intention.

Method Detail

getId

I getId()

setId

void setId(I id)

getName

String getName()

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

Can be null:

true (if true it means its a place holder and does not point to any real item/product or category. Example: Root)

setName

void setName(String name)

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

getParentId

I getParentId()

setParentId

void setParentId(I parentId)

getHierarchy

String getHierarchy()

A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.

setHierarchy

void setHierarchy(String hierarchy)

A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.