org.semanticwb.portal.api.SWBResourceURL Maven / Gradle / Ivy
Show all versions of SWBPortal Show documentation
/*
* SemanticWebBuilder es una plataforma para el desarrollo de portales y aplicaciones de integración,
* colaboración y conocimiento, que gracias al uso de tecnología semántica puede generar contextos de
* información alrededor de algún tema de interés o bien integrar información y aplicaciones de diferentes
* fuentes, donde a la información se le asigna un significado, de forma que pueda ser interpretada y
* procesada por personas y/o sistemas, es una creación original del Fondo de Información y Documentación
* para la Industria INFOTEC, cuyo registro se encuentra actualmente en trámite.
*
* INFOTEC pone a su disposición la herramienta SemanticWebBuilder a través de su licenciamiento abierto al público (‘open source’),
* en virtud del cual, usted podrá usarlo en las mismas condiciones con que INFOTEC lo ha diseñado y puesto a su disposición;
* aprender de él; distribuirlo a terceros; acceder a su código fuente y modificarlo, y combinarlo o enlazarlo con otro software,
* todo ello de conformidad con los términos y condiciones de la LICENCIA ABIERTA AL PÚBLICO que otorga INFOTEC para la utilización
* del SemanticWebBuilder 4.0.
*
* INFOTEC no otorga garantía sobre SemanticWebBuilder, de ninguna especie y naturaleza, ni implícita ni explícita,
* siendo usted completamente responsable de la utilización que le dé y asumiendo la totalidad de los riesgos que puedan derivar
* de la misma.
*
* Si usted tiene cualquier duda o comentario sobre SemanticWebBuilder, INFOTEC pone a su disposición la siguiente
* dirección electrónica:
* http://www.semanticwebbuilder.org.mx
*/
package org.semanticwb.portal.api;
// TODO: Auto-generated Javadoc
/**
* Interfase que sirve para generar un URL valido por el portal para el recursos.
* @author Javier Solis Gonzalez
*/
public interface SWBResourceURL extends SWBResourceModes
{
/**
* Sets the window state of a resource to the given window state.
*
* Possible values are the standard window states and any custom
* window states supported by the portal and the resource.
* Standard window states are:
*
* - MINIMIZED
*
- NORMAL
*
- MAXIMIZED
*
*
* @param state the state
* @return the sWB resource url
* @exception WindowStateException
* if the resource cannot switch to the specified window state.
* To avoid this exception the resource can check the allowed
* window states with Request.isWindowStateAllowed().
* @exception java.lang.IllegalStateException
* if the method is invoked after sendRedirect has been called.
* @see WindowState
*/
public SWBResourceURL setWindowState(String state);
/**
* Gets the window state.
*
* @return the window state
*/
public String getWindowState();
/**
* Gets the call method.
*
* @return the call method
*/
public int getCallMethod();
/**
* Sets the call method.
*
* @param callMethod the call method
* @return the sWB resource url
*/
public SWBResourceURL setCallMethod(int callMethod);
/**
* Sets the resource mode of a resource to the given resource mode.
*
* Possible values are the standard resource modes and any custom
* resource modes supported by the portal and the resource. Resources
* must declare in the deployment descriptor the resource modes they
* support for each markup type.
* Standard resource modes are:
*
* - EDIT
*
- HELP
*
- VIEW
*
*
* Note: The resource may still be called in a different window
* state in the next render call, depending on the resource container / portal.
*
* @param mode the mode
* @return the sWB resource url
* @exception ResourceModeException
* if the resource cannot switch to this resource mode,
* because the resource or portal does not support it for this markup,
* or the current user is not allowed to switch to this resource mode.
* To avoid this exception the resource can check the allowed
* resource modes with Request.isResourceModeAllowed().
* @exception java.lang.IllegalStateException
* if the method is invoked after sendRedirect has been called.
*/
public SWBResourceURL setMode(String mode);
/**
* Gets the mode.
*
* @return the mode
*/
public String getMode();
/**
* Checks if is secure.
*
* @return true, if is secure
*/
public boolean isSecure();
/**
* Sets the secure.
*
* @param secure the secure
* @return the sWB resource url
*/
public SWBResourceURL setSecure(boolean secure);
/** Getter for property action.
* @return Value of property action.
*
*/
public java.lang.String getAction();
/**
* Setter for property action.
*
* @param action New value of property action.
* @return the sWB resource url
*/
public SWBResourceURL setAction(java.lang.String action);
/**
* Returns the resource URL string representation to be embedded in the
* markup.
* Note that the returned String may not be a valid URL, as it may
* be rewritten by the portal/resource-container before returning the
* markup to the client.
*
* @return the encoded URL as a string
*/
public String toString();
/**
* Regresa url del recurso.
*
* @param encodeAmp boolean codifica "&" por "&"
* @return String url
*/
public String toString(boolean encodeAmp);
/**
* Sets a parameter map for the render request.
*
* All previously set render parameters are cleared.
*
* These parameters will be accessible in all
* sub-sequent render calls via the
* ResourceRequest.getParameter call until
* a new request is targeted to the resource.
*
* The given parameters do not need to be encoded
* prior to calling this method.
*
* @param parameters the parameters
* @return the sWB resource url
* @exception java.lang.IllegalArgumentException
* if parameters is null, if
* any of the key/values in the Map are null,
* if any of the keys is not a String, or if any of
* the values is not a String array.
* @exception java.lang.IllegalStateException
* if the method is invoked after sendRedirect has been called.
*/
public SWBResourceURL setParameters(java.util.Map parameters);
/**
* Sets a String parameter for the render request.
*
* These parameters will be accessible in all
* sub-sequent render calls via the
* ResourceRequest.getParameter call until
* a request is targeted to the resource.
*
* This method replaces all parameters with the given key.
*
* The given parameter do not need to be encoded
* prior to calling this method.
*
* @param key the key
* @param value the value
* @return the sWB resource url
* @exception java.lang.IllegalArgumentException
* if key or value are null.
* @exception java.lang.IllegalStateException
* if the method is invoked after sendRedirect has been called.
*/
public SWBResourceURL setParameter(String key, String value);
/**
* Sets a String array parameter for the render request.
*
* These parameters will be accessible in all
* sub-sequent render calls via the
* ResourceRequest.getParameter call until
* a request is targeted to the resource.
*
* This method replaces all parameters with the given key.
*
* The given parameter do not need to be encoded
* prior to calling this method.
*
* @param key the key
* @param values the values
* @return the sWB resource url
* @exception java.lang.IllegalArgumentException
* if key or value are null.
* @exception java.lang.IllegalStateException
* if the method is invoked after sendRedirect has been called.
*/
public SWBResourceURL setParameter(String key, String[] values);
/**
* Regresa tipo de URL (render, action)
* Render = 0
* Action = 1.
*
* @return the uRL type
*/
public int getURLType();
/**
* Getter for property onlyContent.
* @return Value of property onlyContent.
*/
public boolean isOnlyContent();
/**
* Setter for property onlyContent.
*
* @param onlyContent New value of property onlyContent.
* @return the sWB resource url
*/
public SWBResourceURL setOnlyContent(boolean onlyContent);
}