|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpalio.modules.core.Module
palio.modules.Designer
public class Designer
Moduł Designer służy do wykonywania operacji na komponentach jPalio. Wszystkie metody modyfikujące komponenty powinny być
wywoływane w transakcji na konektorze palio.
Operacje dodające i usuwające elementy jpalio a także zmieniające ich treść są wykonywane bezpośrednio na bazie danych. Większość
operacji odczytu właściwości elementów wykorzystuje cache jpalio (nie są wykonywane odczyty z bazy danych). Synchronizacja danych w cache
jpalio z treścią bazy danych jest wykonywana po wywołaniu metody notifyDesigner(), przy czym nie jest to proces natychmiastowy - od
momentu wywołania metody notifyDesigner() do czasu uzupełnienia cache może minąć nawet kilkaset ms, co należy uwzględnić przy
projektowaniu narzędzi wykorzystujących moduł designer.
Field Summary | |
---|---|
static java.lang.Long |
OBJECT_TYPE_GROOVY
Obiekt ze skryptem lub klasą Groovy. |
static java.lang.Long |
OBJECT_TYPE_JAVA
Obiekt z klasą Java. |
static java.lang.Long |
OBJECT_TYPE_JPA_MAPPING_CLASS
Obiekt z mapowaniem JPA dla Hibernate. |
static java.lang.Long |
OBJECT_TYPE_JPALIO_CLASSIC
Obiekt ze skryptem jpalio. |
static java.lang.Long |
OBJECT_TYPE_JPALIO_STATIC
Obiekt typu jpalio static. |
static java.lang.Long |
OBJECT_TYPE_STATIC
Obiekt typu static dla styli css, skryptów java itp. |
Fields inherited from interface palio.modules.core.CurrentModuleDataKeys |
---|
DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT |
Constructor Summary | |
---|---|
Designer(Instance instance,
java.util.Properties parameters)
Domyślny konstruktor. |
Method Summary | |
---|---|
java.lang.Long |
addObject(java.lang.Long treeTypeId,
java.lang.Long typeId,
java.lang.String code,
java.lang.String name,
java.lang.String tag,
java.lang.String description)
Dodaje nowy obiekt. |
java.lang.Long |
addPage(java.lang.Long treeTypeId,
java.lang.String code,
java.lang.String name,
java.lang.Long bodyObjectId,
java.lang.Long headerObjectId,
java.lang.Boolean isProtected,
java.lang.Boolean isNoRefresh,
java.lang.Boolean noChecksum,
java.lang.Boolean isBinary,
java.lang.String mimeType)
Dodaje nową stronę. |
java.lang.Long |
addPage(java.lang.Long treeTypeId,
java.lang.String code,
java.lang.String name,
java.lang.Long bodyObjectId,
java.lang.Long headerObjectId,
java.lang.Boolean isProtected,
java.lang.Boolean isNoRefresh,
java.lang.Boolean noChecksum,
java.lang.Boolean isBinary,
java.lang.String mimeType,
java.lang.Boolean useCodeAsLangCategory)
Dodaje nową stronę. |
java.lang.Long |
addTreeType(java.lang.Long parentId,
java.lang.Long treeTypeId,
java.lang.String code,
java.lang.String name)
Dodaje nowy katalog (wersja wymagająca podania ID - nie jest pobierane z sekwencji). |
java.lang.Long |
addTreeType(java.lang.Long parentId,
java.lang.String code,
java.lang.String name)
Dodaje nowy katalog. |
java.lang.Long |
addTreeTypes(java.lang.Object[] treeTypeCodes)
Dodaje nowe katalogi. |
java.lang.Long |
copyObject(java.lang.String sourceObjectCode,
java.lang.String destObjectCode,
java.lang.Boolean overwrite)
Kopiuje obiekt. |
java.lang.Object[] |
getObject(java.lang.Long objectId)
Zwraca opis obiektu o podanym id w postaci tablicy właściwości. |
java.lang.Object[] |
getObject(java.lang.String objectCode)
Zwraca opis obiektu o podanym kodzie w postaci tablicy właściwości. |
java.lang.String |
getObjectCode(java.lang.Long objectId)
Zwraca kod obiektu o podanym id. |
java.lang.String |
getObjectContent(java.lang.Long objectId)
Zwraca treść obiektu o podanym id. |
java.lang.String |
getObjectContent(java.lang.String objectCode)
Zwraca treść obiektu o podanym kodzie. |
java.lang.Long |
getObjectId(java.lang.String objectCode)
Zwraca id obiektu o podanym kodzie. |
java.lang.Object[] |
getPage(java.lang.Long pageId)
Zwraca opis strony o podanym id w postaci tablicy właściwości. |
java.lang.Object[] |
getPage(java.lang.String pageCode)
Zwraca opis strony o podanym kodzie w postaci tablicy właściwości. |
java.lang.String |
getPageCode(java.lang.Long pageId)
Zwraca kod strony o podanym id. |
java.lang.Long |
getPageId(java.lang.String pageCode)
Zwraca id strony o podanym kodzie. |
java.lang.Object[] |
getTreeType(java.lang.Long treeTypeId)
Zwraca opis katalogu o podanym id w postaci tablicy właściwości. |
java.lang.Long |
getTreeTypeIdByPath(java.lang.String path)
Returns treeTypeCodeId by folder path. |
java.lang.String |
getVersion()
Returns the module version |
void |
notifyDesigner()
Powiadamia jDesigner'a o zmianach dokonanych za pomocą modułu Designer. |
java.lang.Boolean |
objectExists(java.lang.Long objectId)
Sprawdza czy istnieje obiekt o podanym id. |
java.lang.Boolean |
objectExists(java.lang.String objectCode)
Sprawdza czy istnieje obiekt o podanym kodzie. |
java.lang.Boolean |
pageExists(java.lang.Long pageId)
Sprawdza czy istnieje strona o podanym id. |
java.lang.Boolean |
pageExists(java.lang.String pageCode)
Sprawdza czy istnieje strona o podanym kodzie. |
void |
removeObject(java.lang.Long objectId)
Usuwa obiekt. |
void |
removeObject(java.lang.String objectCode)
Usuwa obiekt. |
void |
removePage(java.lang.Long pageId)
Usuwa stronę o podanym id. |
void |
removePage(java.lang.String pageCode)
Usuwa stronę o podanym kodzie. |
void |
removeTreeType(java.lang.Long treeTypeId)
Usuwa katalog o podanym id. |
java.lang.Boolean |
treeTypeExists(java.lang.Long treeTypeId)
Sprawdza czy istnieje katalog o podanym id. |
void |
updateObject(java.lang.Long id,
java.lang.Long newTreeTypeId,
java.lang.Long newTypeId,
java.lang.String newCode,
java.lang.String newName,
java.lang.String newTag,
java.lang.String newDescription)
Aktualizuje obiekt. |
void |
updateObjectContent(java.lang.Long objectId,
java.lang.String newTag)
Aktualizuje treść obiektu. |
void |
updateObjectContent(java.lang.String objectCode,
java.lang.String newTag)
Aktualizuje treść obiektu. |
void |
updatePage(java.lang.Long pageId,
java.lang.Long treeTypeId,
java.lang.String code,
java.lang.String name,
java.lang.Long bodyObjectId,
java.lang.Long headerObjectId,
java.lang.Boolean isProtected,
java.lang.Boolean isNoRefresh,
java.lang.Boolean noChecksum,
java.lang.Boolean isBinary,
java.lang.String mimeType,
java.lang.Boolean useCodeAsLangCategory)
Aktualizuje stronę. |
void |
updateTreeType(java.lang.Long id,
java.lang.String newCode,
java.lang.String newName)
Aktualizuje katalog. |
void |
updateTreeTypeParentId(java.lang.Long id,
java.lang.Long newParentId)
Przenosi katalog do innego katalogu. |
Methods inherited from class palio.modules.core.Module |
---|
getConfigParam, getDescription, getModuleTranslation |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Long OBJECT_TYPE_JPALIO_CLASSIC
public static final java.lang.Long OBJECT_TYPE_JPALIO_STATIC
public static final java.lang.Long OBJECT_TYPE_GROOVY
public static final java.lang.Long OBJECT_TYPE_JAVA
public static final java.lang.Long OBJECT_TYPE_JPA_MAPPING_CLASS
public static final java.lang.Long OBJECT_TYPE_STATIC
Constructor Detail |
---|
public Designer(Instance instance, java.util.Properties parameters)
instance
- instancja, dla której ma zostać utworzony modułparameters
- parametry konfiguracyjne modułuMethod Detail |
---|
public java.lang.String getVersion()
getVersion
in class Module
public java.lang.Long addTreeType(java.lang.Long parentId, java.lang.String code, java.lang.String name) throws palio.PalioException
parentId
- identyfikator katalogu nadrzędnegocode
- kod kataloguname
- nazwa typu
palio.PalioException
public java.lang.Long addTreeType(java.lang.Long parentId, java.lang.Long treeTypeId, java.lang.String code, java.lang.String name) throws palio.PalioException
parentId
- identyfikator katalogu nadrzędnegotreeTypeId
- id katalogucode
- kod kataloguname
- nazwa typu
palio.PalioException
public java.lang.Long addTreeTypes(java.lang.Object[] treeTypeCodes) throws palio.PalioException
treeTypeCodes
- tablica kodów katalogów
palio.PalioException
public void removeTreeType(java.lang.Long treeTypeId) throws palio.PalioException
treeTypeId
- identyfikator katalogu
palio.PalioException
public void updateTreeTypeParentId(java.lang.Long id, java.lang.Long newParentId) throws palio.PalioException
id
- id katalogu do przeniesienianewParentId
- nowe id katalogu nadrzędnego, null oznacza przeniesienie do katalogu głównego
palio.PalioException
public void updateTreeType(java.lang.Long id, java.lang.String newCode, java.lang.String newName) throws palio.PalioException
updateTreeTypeParentId
.
id
- identyfikator katalogunewCode
- nowy kod katalogunewName
- nowa nazwa katalogu
palio.PalioException
public java.lang.Boolean treeTypeExists(java.lang.Long treeTypeId)
treeTypeId
- id katalogu
public java.lang.Long getTreeTypeIdByPath(java.lang.String path) throws palio.PalioException
path
- folder path
palio.PalioException
public java.lang.Object[] getTreeType(java.lang.Long treeTypeId)
treeTypeId
- id katalogu
public java.lang.Long addObject(java.lang.Long treeTypeId, java.lang.Long typeId, java.lang.String code, java.lang.String name, java.lang.String tag, java.lang.String description) throws palio.PalioException
treeTypeId
- identyfikator folderu, do którego ma zostać dodany obiekttypeId
- typ obiektu określony stałymi OBJECT_TYPE_XXXcode
- kod obiektuname
- nazwa obiektutag
- treść obiektudescription
- opis obiektu
palio.PalioException
public void updateObject(java.lang.Long id, java.lang.Long newTreeTypeId, java.lang.Long newTypeId, java.lang.String newCode, java.lang.String newName, java.lang.String newTag, java.lang.String newDescription) throws palio.PalioException
id
- identyfikator obiektunewTreeTypeId
- nowy identyfikator folderunewTypeId
- typeId typ obiektu określony stałymi OBJECT_TYPE_XXXnewCode
- nowy kodnewName
- nowa nazwanewTag
- nowa zawartośćnewDescription
- nowy opis
palio.PalioException
public void updateObjectContent(java.lang.String objectCode, java.lang.String newTag) throws palio.PalioException
objectCode
- identyfikator obiektunewTag
- nowa treść obiektu
palio.PalioException
public void updateObjectContent(java.lang.Long objectId, java.lang.String newTag) throws palio.PalioException
objectId
- identyfikator obiektunewTag
- nowa treść obiektu
palio.PalioException
public java.lang.Long copyObject(java.lang.String sourceObjectCode, java.lang.String destObjectCode, java.lang.Boolean overwrite) throws palio.PalioException
sourceObjectCode
- kod obiektu źródłowegodestObjectCode
- kod obiektu docelowegooverwrite
- czy nadpisać istniejący
palio.PalioException
public void removeObject(java.lang.String objectCode) throws palio.PalioException
objectCode
- kod obiektu
palio.PalioException
public void removeObject(java.lang.Long objectId) throws palio.PalioException
objectId
- identyfikator obiektu
palio.PalioException
public java.lang.Boolean objectExists(java.lang.Long objectId)
objectId
- id obiektu
public java.lang.Boolean objectExists(java.lang.String objectCode)
objectCode
- kod obiektu
public java.lang.Long getObjectId(java.lang.String objectCode)
objectCode
- kod obiektu
public java.lang.String getObjectCode(java.lang.Long objectId)
objectId
- id obiektu
public java.lang.String getObjectContent(java.lang.String objectCode) throws palio.PalioException
objectCode
- kod obiektu
palio.PalioException
public java.lang.String getObjectContent(java.lang.Long objectId) throws palio.PalioException
objectId
- id obiektu
palio.PalioException
public java.lang.Object[] getObject(java.lang.String objectCode)
objectCode
- kod obiektu
public java.lang.Object[] getObject(java.lang.Long objectId)
objectId
- id obiektu
public java.lang.Long addPage(java.lang.Long treeTypeId, java.lang.String code, java.lang.String name, java.lang.Long bodyObjectId, java.lang.Long headerObjectId, java.lang.Boolean isProtected, java.lang.Boolean isNoRefresh, java.lang.Boolean noChecksum, java.lang.Boolean isBinary, java.lang.String mimeType, java.lang.Boolean useCodeAsLangCategory) throws palio.PalioException
treeTypeId
- identyfikator katalogu, do którego ma zostać dodany obiektcode
- kod stronyname
- nazwa stronybodyObjectId
- identyfikator obiektu stanowiącego treść stronyheaderObjectId
- identyfikator obiektu nagłówka httpisProtected
- czy chroniona przywilejamiisNoRefresh
- czy odświeżanie zabronionenoChecksum
- czy nie chroniona sumą kontrolną (false - chroniona)isBinary
- czy binarnamimeType
- mimetype stronyuseCodeAsLangCategory
- czy ustawić kod strony jako kod kategorii tłumaczeń
palio.PalioException
public java.lang.Long addPage(java.lang.Long treeTypeId, java.lang.String code, java.lang.String name, java.lang.Long bodyObjectId, java.lang.Long headerObjectId, java.lang.Boolean isProtected, java.lang.Boolean isNoRefresh, java.lang.Boolean noChecksum, java.lang.Boolean isBinary, java.lang.String mimeType) throws palio.PalioException
treeTypeId
- identyfikator katalogu, do którego ma zostać dodany obiektcode
- kod stronyname
- nazwa stronybodyObjectId
- identyfikator obiektu stanowiącego treść stronyheaderObjectId
- identyfikator obiektu nagłówka httpisProtected
- czy chroniona przywilejamiisNoRefresh
- czy odświeżanie zabronionenoChecksum
- czy nie chroniona sumą kontrolną (false - chroniona)isBinary
- czy binarnamimeType
- mimetype strony
palio.PalioException
public void updatePage(java.lang.Long pageId, java.lang.Long treeTypeId, java.lang.String code, java.lang.String name, java.lang.Long bodyObjectId, java.lang.Long headerObjectId, java.lang.Boolean isProtected, java.lang.Boolean isNoRefresh, java.lang.Boolean noChecksum, java.lang.Boolean isBinary, java.lang.String mimeType, java.lang.Boolean useCodeAsLangCategory) throws palio.PalioException
pageId
- identyfikator obiektutreeTypeId
- identyfikator katalogu, do którego ma zostać dodany obiektcode
- kod stronyname
- nazwa stronybodyObjectId
- identyfiaktor obiektu stanowiącego treść stronyheaderObjectId
- identyfikator obiektu nagłówka httpisProtected
- czy chroniona przywilejamiisNoRefresh
- czy odświeżanie zabronionenoChecksum
- czy nie chroniona sumą kontrolną (false - chroniona)isBinary
- czy binarnamimeType
- mimetype stronyuseCodeAsLangCategory
- czy ustawić kod strony jako kod kategorii tłumaczeń
palio.PalioException
public void removePage(java.lang.String pageCode) throws palio.PalioException
pageCode
- kod strony
palio.PalioException
public void removePage(java.lang.Long pageId) throws palio.PalioException
pageId
- identyfikator strony
palio.PalioException
public java.lang.Boolean pageExists(java.lang.String pageCode)
pageCode
- kod strony
public java.lang.Boolean pageExists(java.lang.Long pageId)
pageId
- id strony
public java.lang.Long getPageId(java.lang.String pageCode)
pageCode
- kod strony
public java.lang.String getPageCode(java.lang.Long pageId)
pageId
- id strony
public java.lang.Object[] getPage(java.lang.String pageCode) throws palio.PalioException
pageCode
- id obiektu
palio.PalioException
public java.lang.Object[] getPage(java.lang.Long pageId) throws palio.PalioException
pageId
- id obiektu
palio.PalioException
public void notifyDesigner()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |