org.efaps.ui.wicket.resources.EFapsContentReference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of efaps-webapp Show documentation

eFaps WebApp provides a web interface as the User Interface for eFaps which can be easily expanded and altered.

There is a newer version: 3.2.0

/*
 * Copyright 2003 - 2009 The eFaps Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Revision:        $Rev: 3447 $
 * Last Changed:    $Date: 2009-11-29 17:46:39 -0500 (Sun, 29 Nov 2009) $
 * Last Changed By: $Author: tim.moxter $
 */

package org.efaps.ui.wicket.resources;

import org.apache.wicket.IClusterable;

import org.efaps.util.RequestHandler;

/**
 * This class is used as a Reference to an Object in the eFaps-DataBase.

 *
 * @author jmox
 * @version $Id: EFapsContentReference.java 3447 2009-11-29 22:46:39Z tim.moxter $
 */
public class EFapsContentReference implements IClusterable {

  private static final long serialVersionUID = 1L;

  /**
   * the name of this EFapsContentReference. With this name the Object from the
   * eFpas-DataBase will be identified.
   */
  private final String name;

  /**
   * Constructor setting the name of the EFapsContentReference, from combining
   * the name of the class and the name.
   *
   * @param _scope
   *                class the name will be included
   * @param _name
   *                name of the Object
   */
  public EFapsContentReference(final Class _scope, final String _name) {
    this(_scope.getPackage().getName() + "." + _name);
  }

  /**
   * Constructor setting the name of the EFapsContentReference
   *
   * @param _name
   *                Name to set
   */
  public EFapsContentReference(final String _name) {
    this.name = _name;
  }

  /**
   * This is the getter method for the instance variable {@link #name}.
   *
   * @return value of instance variable {@link #name}
   */
  public String getName() {
    return this.name;
  }

  /**
   * get the URL to an Image from the eFaps-DataBase
   *
   * @return URL as a String
   */
  public String getImageUrl() {
    return RequestHandler.replaceMacrosInUrl(RequestHandler.URL_IMAGE
        + this.name);
  }

  /**
   * get the URL to a Static Content from the eFaps-DataBase
   *
   * @return URL as a String
   */
  public String getStaticContentUrl() {
    return RequestHandler.replaceMacrosInUrl(RequestHandler.URL_STATIC
        + this.name);
  }
}