public interface PSEntity extends Serializable
Modifier and Type | Method and Description |
---|---|
EntityValidity |
checkValid()
Determines whether this object is valid based on known PageSeeder constraints.
|
Long |
getId() |
String |
getIdentifier()
Returns the identifier to use when connecting to PageSeeder based on the ID available.
|
String |
getKey() |
boolean |
isIdentifiable()
Determines whether the entity can be identified in PageSeeder.
|
boolean |
isValid()
Determines whether the entity is valid based on known PageSeeder constraints.
|
Long getId()
String getKey()
boolean isValid()
true
if the object is intrinsically valid based on its internal values;
false
if any of its attributes violates a PageSeeder constraint.boolean isIdentifiable()
To be identifiable, the entity must have either a private id or a public id.
If the public ID does not correspond to a single attribute in PageSeeder, then a combination of attributes may be used to determine whether it is possible to identify the entity.
true
if the object can be identified in PageSeeder;
false
if it is not possible to identify the entity form its attributes or keys.String getIdentifier()
When both the private and public identifier are available, the private identifier takes precedence over the public one.
When the public identifier cannot be used on its own, then only the private ID is returned.
In general, if the isIdentifiable()
method return true
, this
method should return a value. When it is not the case, it should be clearly documented.
EntityValidity checkValid()
true
if the object is intrinsically valid based on its internal values;
false
if any of its attributes violates a PageSeeder constraint.Copyright © 2016 Allette Systems. All rights reserved.