|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.friendlyurl.FriendlyURL
public class FriendlyURL
This class represents a friendly Url and provides an interface to generate friendly Url string based on the provided information.
Field Summary | |
---|---|
protected int |
m_childId
Additional id specifier, used for example for Urls to community pages which also needs the community name. |
protected java.lang.String |
m_childName
Additional name specifier, used for example for Urls to community pages which also needs the community name. |
protected int |
m_classId
Type of destination page the url links too |
protected int |
m_objectId
Id of the object to generate friendly name to (either one of name or id must be provided) |
protected java.lang.String |
m_objectName
objectName Name of the object to generate friendly name to (either one of name or id must be provided) |
protected java.lang.String |
m_queryParams
String of query parameters that need to be attached at the end of the friendly URL |
protected boolean |
m_useIdIfAvailable
Whether to generate the object id in the URL if the name is also available |
Constructor Summary | |
---|---|
FriendlyURL(int classId,
int objectId)
Constructor with object id as argument |
|
FriendlyURL(int classId,
java.lang.String objectName)
Constructor with object name as argument |
|
FriendlyURL(int classId,
java.lang.String objectName,
int objectId)
|
|
FriendlyURL(int classId,
java.lang.String objectName,
int objectId,
java.lang.String queryParams)
|
Method Summary | |
---|---|
static java.lang.String |
DeNormalizeObjectName(java.lang.String objectName)
Reverses any character replacement performed in FriendlyURL#NormalizeObjectName ,
except for character casing. |
int |
GetChildId()
|
java.lang.String |
GetChildName()
|
int |
GetClassId()
|
java.lang.String |
GetClassIdAsString()
|
java.lang.String |
GetFriendlyURL(AActivitySpace space)
Constructs the Friendly URL and returns it as a string. |
java.lang.String |
GetFullFriendlyURL(AActivitySpace space)
Constructs the Friendly URL and returns it as a string. |
int |
GetObjectId()
|
java.lang.String |
GetOjectName()
|
boolean |
GetUseIdIfAvailable()
|
static java.lang.String |
NormalizeObjectName(java.lang.String objectName)
Convert PTObject name into a format that is suitable for friendly Urls. |
void |
SetChildId(int id)
|
void |
SetChildName(java.lang.String name)
|
void |
SetClassId(int id)
|
void |
SetObjectId(int id)
|
void |
SetObjectName(java.lang.String name)
|
void |
SetUseIdIfAvailable(boolean useidIfAvailable)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected int m_classId
protected java.lang.String m_objectName
protected int m_objectId
protected java.lang.String m_queryParams
protected java.lang.String m_childName
protected int m_childId
protected boolean m_useIdIfAvailable
Constructor Detail |
---|
public FriendlyURL(int classId, java.lang.String objectName)
classId
- public FriendlyURL(int classId, java.lang.String objectName, int objectId)
public FriendlyURL(int classId, int objectId)
classId
- public FriendlyURL(int classId, java.lang.String objectName, int objectId, java.lang.String queryParams)
Method Detail |
---|
public java.lang.String GetFriendlyURL(AActivitySpace space)
space
- Current ActivitySpace
public java.lang.String GetFullFriendlyURL(AActivitySpace space)
space
- Current ActivitySpace
public static java.lang.String NormalizeObjectName(java.lang.String objectName)
FriendlyURL#DeNormalizeObjectName
to convert the value back.
The casing of the object name is not preserved through the conversion
NOTE: This method is duplicated on ObjectIdFromNameCache class in the server. Make sure to update
both methods.
public static java.lang.String DeNormalizeObjectName(java.lang.String objectName)
FriendlyURL#NormalizeObjectName
,
except for character casing. All characters will be lower case.
NOTE: This method is duplicated on ObjectIdFromNameCache class in the server. Make sure to update
both methods.
public java.lang.String GetChildName()
public void SetChildName(java.lang.String name)
public int GetClassId()
public java.lang.String GetClassIdAsString()
public void SetClassId(int id)
public int GetObjectId()
public void SetObjectId(int id)
public java.lang.String GetOjectName()
public void SetObjectName(java.lang.String name)
public boolean GetUseIdIfAvailable()
public void SetUseIdIfAvailable(boolean useidIfAvailable)
public int GetChildId()
public void SetChildId(int id)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |