|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.application.transform.disassembler.xip.ExportImportContext com.bea.netuix.application.transform.disassembler.xip.ImportContext
public class ImportContext
This context is used to define rules when importing a resource into the database from a portal file (.portal, .pinc, .book, or .page).
Import options - these options are used as rules to the export/import utility scope - Changes can be scoped to the "library", "admin", or "visitor" when importing a .pinc, .book, or .page file, and "admin" or "visitor" when exporting a .portal file. If this property has a value of "admin" or "visitor" then a xip.identifier.portal.path and xip.identifier.desktop.path must be specified. To scope exports to the "library" or "admin" you must be in the Admin or PortalSystemAdministrator Role. doDeletes - If true, then books, pages and portlets that are currently on the existing desktop in the database but not in the new import file will be removed from existing desktop. doMoves - (InnerMoves) If true, then existing books, pages and portlets that are in different locations on the same parent will be moved to the correct location. If you want to move books, pages and portlets across different parents then seeouterMoves
doOuterMoves - If true, then existing books, pages and portlets that are moved from different parents
will be moved to the new parent. If this is not set then it will be handled as a remove and add
(different customizations are lost).
doUpdates - If true, then books, pages and portlets that are currently not on the existing
desktop will be added, and any instance attributes on the books, page, and portlet will
be updated in the database.
abortIfPortletsMissing - if true, then if the new file references a portlet that is
not in the current webapp then abort, otherwise skip the portlet and continue
on.
modifyDefinitions - If this flag is set to true then any changes in the import file will affect the
definitions and not just the instances. These include things like markup (backing files, rollover images,
isHidden; for a more complete list refer to the database schema). It is important to note that
these changes may affect other desktops outside the one you are scoping it
to.
propagate - Typically all changes that are made to Library artifacts are cascaded down to the
admin's desktop and subsequently cascaded down to the visitor's view. If this
property is set to CustomizationContext.PROLIFERATE_SYNC
then
these changes will occur synchronously as part of this transaction. If this
property is set to CustomizationContext.PROLIFERATE_OFF
then changes
will not get cascaded for the artifacts which have been modified. For books,
pages and portlets that have not been modified at the admin or visitor level,
then these will always receive the changes as they point
to the default. If this property is set to
CustomizationContext.PROLIFERATE_ASYNC
then these changes will occur
asynchronously.
createPortal - If this flag is set, then when importing a desktop and the
given portal is not already created, one will be created for you.
portalTitle - If createPortal
is set and a new portal is being
created it needs a title. This property value will be the new portal's
title.
locale - the locale of the titles and descriptions in the file. Note the encoding is defined in the
file itself.
proliferatePreferences - When portlet preference changes are made to an library or admin instance, it's
possible to indicate whether these changes should be pushed down through to the visitors. Setting
this property to true (default) does just that. Setting this property to false only makes changes to
preferences user's have not yet customized.
Field Summary | |
---|---|
static String |
DEFAULT_PORTAL_TITLE
|
static short |
PROLIFERATE_ASYNC
Do not propagate changes to instances asynchronously. |
static short |
PROLIFERATE_OFF
Do not propagate changes to instances. |
static short |
PROLIFERATE_SYNC
Do not propagate changes to instances synchronously, as part of the same transaction as the update. |
static short |
PROPAGATE_OFF
Deprecated use ImportContext.PROLIFERATE_OFF |
static short |
PROPAGATE_SYNC
Deprecated use ImportContext.PROLIFERATE_SYNC |
Fields inherited from class com.bea.netuix.application.transform.disassembler.xip.ExportImportContext |
---|
ADMIN_SCOPE, DEFAULT_LOCALE, LIBRARY_SCOPE, locale, scope, VISITOR_SCOPE |
Constructor Summary | |
---|---|
ImportContext()
|
Method Summary | |
---|---|
boolean |
abortIfPortletsMissing()
|
void |
addPreferenceDestinationMaster(String definitionLabel,
List<String> preferenceKeys)
Add a preference key for the given portlet to be left alone on the destination. |
Object |
clone()
|
boolean |
createPortal()
|
boolean |
doDeletes()
|
boolean |
doMoves()
|
boolean |
doOuterMoves()
|
boolean |
doUpdates()
|
boolean |
getHadError()
Was there an error? This field is set after the import operation has been completed. |
String |
getPortalTitle()
|
List<String> |
getPreferenceDestinationMaster(String definitionLabel)
Return the preference key names for the preferences that should be left alone on the destination |
short |
getProliferateChanges()
|
short |
getPropagateChanges()
Deprecated use getProliferateChanges() |
boolean |
getSuppressErrorMessages()
|
String |
getUsername()
|
boolean |
isProliferatePreferences()
|
boolean |
modifyDefinitions()
|
void |
setAbortIfPortletsMissing(boolean abortIfPortletsMissing)
|
void |
setCreatePortal(boolean createPortal)
|
void |
setDoDeletes(boolean doDeletes)
|
void |
setDoMoves(boolean doMoves)
|
void |
setDoOuterMoves(boolean doOuterMoves)
|
void |
setDoUpdates(boolean doUpdates)
|
void |
setHadError(boolean hadError)
|
void |
setModifyDefinitions(boolean modifyDefinitions)
|
void |
setPortalTitle(String portalTitle)
|
void |
setProliferateChanges(short proliferateChanges)
|
void |
setProliferatePreferences(boolean proliferatePreferences)
|
void |
setPropagateChanges(short propagateChanges)
Deprecated use setProliferateChanges(short ) |
void |
setSuppressErrorMessages(boolean suppressErrorMessages)
|
void |
setUsername(String username)
|
Methods inherited from class com.bea.netuix.application.transform.disassembler.xip.ExportImportContext |
---|
getLocale, getScope, setLocale, setLocale, setScope |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_PORTAL_TITLE
@Deprecated public static final short PROPAGATE_OFF
@Deprecated public static final short PROPAGATE_SYNC
public static final short PROLIFERATE_OFF
public static final short PROLIFERATE_SYNC
public static final short PROLIFERATE_ASYNC
Constructor Detail |
---|
public ImportContext()
Method Detail |
---|
public boolean doDeletes()
public void setDoDeletes(boolean doDeletes)
public boolean doMoves()
public void setDoMoves(boolean doMoves)
public boolean doOuterMoves()
public void setDoOuterMoves(boolean doOuterMoves)
public boolean doUpdates()
public void setDoUpdates(boolean doUpdates)
public boolean abortIfPortletsMissing()
public void setAbortIfPortletsMissing(boolean abortIfPortletsMissing)
public short getProliferateChanges()
public void setProliferateChanges(short proliferateChanges)
@Deprecated public short getPropagateChanges()
@Deprecated public void setPropagateChanges(short propagateChanges)
public void setModifyDefinitions(boolean modifyDefinitions)
public boolean modifyDefinitions()
public boolean createPortal()
public void setCreatePortal(boolean createPortal)
public String getPortalTitle()
public void setPortalTitle(String portalTitle)
public String getUsername()
public void setUsername(String username)
public boolean getSuppressErrorMessages()
public void setSuppressErrorMessages(boolean suppressErrorMessages)
public boolean isProliferatePreferences()
public void setProliferatePreferences(boolean proliferatePreferences)
public boolean getHadError()
public void setHadError(boolean hadError)
public List<String> getPreferenceDestinationMaster(String definitionLabel)
definitionLabel
- the definition of the portlet
public void addPreferenceDestinationMaster(String definitionLabel, List<String> preferenceKeys)
definitionLabel
- definition label of the portlet. You can use the wildecard "*" to denote all portlets.preferenceKeys
- preference key namespublic Object clone()
clone
in class Object
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |