001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.metamodel.facets.object.parseable;
021
022import org.apache.isis.applib.profiles.Localization;
023import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
024import org.apache.isis.core.metamodel.facets.MultipleValueFacet;
025import org.apache.isis.core.metamodel.facets.object.title.TitleFacet;
026
027/**
028 * Indicates that this class can parse an entry string.
029 */
030public interface ParseableFacet extends MultipleValueFacet {
031
032    /**
033     * Parses a text entry made by a user and sets the domain object's value.
034     * 
035     * <p>
036     * Equivalent to <tt>Parser#parseTextEntry(Object, String)</tt>, though may
037     * be implemented through some other mechanism.
038     * @param localization TODO
039     * 
040     * @throws InvalidEntryException
041     * @throws TextEntryParseException
042     */
043    ObjectAdapter parseTextEntry(ObjectAdapter original, String text, Localization localization);
044
045    /**
046     * A title for the object that is valid but which may be easier to edit than
047     * the title provided by a {@link TitleFacet}.
048     * 
049     * <p>
050     * The idea here is that the viewer can display a parseable title for an
051     * existing object when, for example, the user initially clicks in the
052     * field. So, a date might be rendered via a {@link TitleFacet} as
053     * <tt>May 2, 2007</tt>, but its parseable form might be <tt>20070502</tt>.
054     */
055    public String parseableTitle(ObjectAdapter obj);
056}